API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointChangelog
Design: Test
Intents
Intents: Asset
Intents: Content
Intents: Data
Intents: Design
Intents: Test
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
User: Test
App middleware: Express
Error
Error: Test
publish.launch
API reference for the publish.launch method.
Launches the design publish with the content publisher intent.
Usage: Launch the content publisher with the same app
import { publish } from "@canva/design";import { features } from "@canva/platform";if (features.isSupported(publish.launch)) {await publish.launch({ withContentPublisher: 'self' });}
TYPESCRIPT
Parameters
optsLaunchPublishOptsRequired
Options for configuring the publish menu.
withContentPublisherstringRequired
The option to make sure the content publisher intent of the current app will be triggered.
The only valid value is "self".
Returns
Promise<void>
Throws
unsupported_surface code if not invoked by the design editor intent.