Skip navigation
Skip to main content
Canva Developers logo
API reference
API reference

appProcess

API reference for the appProcess namespace.

A namespace that organizes methods and properties related to app processes.

Usage

import { appProcess } from "@canva/preview/platform";
tsx

Properties

#broadcastMessagefunction
Required

Sends a message to all active app processes.

To learn more, see appProcess.broadcastMessage.

#currentobject
Required

Represents the current app process.

To learn more, see appProcess.current.

#registerOnMessagefunction
Required

Registers a callback that runs when an app process receives a message.

To learn more, see appProcess.registerOnMessage.

#registerOnStateChangefunction
Required

Registers a callback that runs when the state of an app process changes.

To learn more, see appProcess.registerOnStateChange.

#requestClosefunction
Required

Requests the termination of an app process.

To learn more, see appProcess.requestClose.