Skip navigation

Skip to main content

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.

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions getDesignToken initAppElement openDesign overlay.registerOnCanOpen requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl

User

auth.getCanvaUserToken auth.initOauth

appProcess

API reference for the appProcess namespace.

Provides methods for interacting with an app process.

Properties

currentCurrentAppProcessRead-only

Required

The current app process.

For more information, see appProcess.current.

Methods

requestClosefunction

Required

Requests the termination of the specified app process.

For more information, see appProcess.requestClose.

registerOnStateChangefunction

Required

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

For more information, see appProcess.registerOnStateChange.

registerOnMessagefunction

Required

Registers a callback that listens for broadcasted messages.

For more information, see appProcess.registerOnMessage.

broadcastMessagefunction

Required

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

For more information, see appProcess.broadcastMessage.