API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDefaultPageDimensionsgetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointui.startDragChangelog
Design: Test
Error
Error: Test
Intents
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
User: Test
requestBrandTemplates
API reference for the requestBrandTemplates method.
Trigger brand template selection panel and returns the selected template token.
Usage: Request brand templates
import { requestBrandTemplates } from "@canva/design";const response = await requestBrandTemplates();if (response.status === 'aborted') return;const { token } = response.brandTemplates[0];
TYPESCRIPT
Returns
Response object from the RequestBrandTemplate operation. This is a Promise that resolves with the following object:
Response object from the RequestBrandTemplate operation completed successfully.
statusstringThe only valid value is "completed".
brandTemplatesRequestBrandTemplatesResponseContent[]Response object from the RequestBrandTemplate operation completed successfully.
tokenstringResponse object from the RequestBrandTemplate operation that was aborted.
statusstringThe only valid value is "aborted".