API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignTokeninitAppElementoverlay.registerOnCanOpenopenDesignrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInforequestOpenExternalUrl
appProcess.requestClose
API reference for the appProcess.requestClose 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.
Requests the termination of the specified app process.
Once called, this method:
- Transitions the state of the process to
"closing". - Invokes all registered
setOnDisposecallbacks. - Waits for the process to finish closing.
- Transitions the state of the process to
"closed".
Each time the state changes, all of the registerOnStateChange callbacks are called..
Parameters
targetAppProcessIdREQUIRED
The ID of an app process.
paramsTREQUIRED
Parameters to pass to the setOnDispose callback. Any kind of structured data can be passed via this property.
Properties of params
reasonCloseReasonREQUIRED
The reason the app process is closing.
The available options include:
"completed""aborted"
Returns
Promise<void>