Closes an open plugin window and the associated draft composer
This function is only available for composer plugins
This function is only available on Context of type
messageComposer
function closeDraft(cancelToken?: CancelToken): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
cancelToken | CancelToken (optional) | Token to cancel the request. |
Usage
This function should be used when an intended user action has been completed and the composer plugin modal and draft composer no longer need to be open.
Example: The user completes an action in the plugin to send a message directly with a third-party, after which point this function is used to close the modal and composer on behalf of the user.
About the composer plugin modal
The composer plugin window is a feature that developers can add to their apps so that users can open composer plugins from the composer toolbar in the Front UI. The modal cannot be opened directly through the SDK. It can only be opened by the user interacting with the UI.
Examples
Front.closeDraft();