On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

appProcess

API reference for the appProcess namespace.
This version of the API is in beta. Beta APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Provides methods for interacting with an app process.

Properties

currentCurrentAppProcess
REQUIRED

The current app process.

To learn more, see appProcess.current.

Methods

requestClosefunction
REQUIRED

Requests the termination of the specified app process.

To learn more, see appProcess.requestClose.

registerOnStateChangefunction
REQUIRED

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

To learn more, see appProcess.registerOnStateChange.

registerOnMessagefunction
REQUIRED

Registers a callback that listens for broadcasted messages.

To learn more, see appProcess.registerOnMessage.

broadcastMessagefunction
REQUIRED

Broadcasts a message to all of the app's active processes, not including the current process.

To learn more, see appProcess.broadcastMessage.