API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignTokeninitAppElementoverlay.registerOnCanOpenopenDesignrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInforequestOpenExternalUrl
requestOpenExternalUrl
API reference for the requestOpenExternalUrl method.
This version of the API is in beta. Beta APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.
Opens an external URL.
The URL is opened natively, such as in a new browser tab on desktop or in a browser sheet on mobile.
In some browsers, the user must enable popup permissions before any URL can be opened.
Parameters
request
OpenExternalUrlRequest
REQUIRED
Options for prompting the user to open an external URL.
Properties of request
url
string
REQUIRED
The URL to open.
Returns
The result of prompting the user to open an external URL. This is a Promise
that resolves with the following object:
The result when a user agrees to navigate to an external URL.
status
string
The status of the request.
This must be "completed"
.
The result when a user doesn't agree to navigate to an external URL.
status
string
The status of the request.
This must be "aborted"
.