API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Intents: data
Intents: design
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrl
openDesign
API reference for the openDesign method.
Reads a specified part of the user's design and returns all elements in that part.
Parameters
optionsDesignOpenOptionsRequired
Options for configuring how the design is read.
typestringRequired
The type of context.
The only valid value is "current_page".
callbackDesignOpenCallbackRequired
A callback for operating on the design.
Parameters
sessionDesignEditing.CurrentPageSessionRequired
Session received by the openDesign callback.
pageDesignEditing.PageRequired
The current page of the design.
A page with either fixed or unbounded dimensions.
For more information, see AbsolutePage.
Represents something that's not supported by the Apps SDK.
typestringRead-onlyRequired
The only valid value is "unsupported".
helpersDesignEditing.PageHelpersRequired
These are various utilities that allow apps to do more complex operations on the page.
For more information, see PageHelpers.
syncfunctionRequired
Saves any changes made during the session while keeping the session open.
- Any changes in the session are only reflected in the design after this method is called.
- Once this method is called, further changes in the session can still be made.
Returns
Promise<void>
Returns
Promise<void>
Returns
Promise<void>