API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignTokeninitAppElementoverlay.registerOnCanOpenrequestExportselection.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.
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
targetAppProcessIdRequiredThe ID of an app process.
paramsTRequiredParameters to pass to the setOnDispose callback. Any kind of structured data can be passed via this property.
reasonCloseReasonRequiredThe reason the app process is closing.
Available values:
"completed""aborted"
Returns
Promise<void>