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.current

API reference for the appProcess.current property.
This version of the API is deprecated. This version will soon be unsupported. You should use a stable version of the API in your app.

An object that contains methods for interacting with the current process.

Usage

import { appProcess } from "@canva/platform";
console.log(appProcess.current);
TSX

Properties

getInfofunction
REQUIRED

Gets information about the current process.

To learn more, see appProcess.current.getInfo.

requestClosefunction
REQUIRED

Requests the termination of the current process.

To learn more, see appProcess.current.requestClose.

setOnDisposefunction
REQUIRED

Registers a callback that runs when the current process is about to close.

To learn more, see appProcess.current.setOnDispose.