close

Closes the composer plugin window.

πŸ“˜

This function is only available for composer plugins

This function is only available on Context of type messageComposer

function close(cancelToken?: CancelToken): Promise<void>;

Parameters

ParameterTypeDescription
cancelTokenCancelToken (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 no longer needs to be open.

Example: The user selects a file to attach to the message from your composer plugin window, after which point this function is used to close the modal 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.close();