GuidesAPI ReferenceChangelogCommunity
Front

requestClose

Closes the popover window.

📘

This function is only available when a popover window is open

This function is only available on Context of type singleConversationPopover and noConversationPopover.

function requestClose(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 popover no longer needs to be open.

Example: The user selects a file to attach to the message from your plugin's popover window, after which point this function is used to close the popover on behalf of the user.

📘

About the popover window

The popover window is a feature that developers can add to their apps so that users can open popover windows from the Front UI. The popover cannot be opened directly through the SDK. It can only be opened by the user interacting with the UI.

Examples

Front.requestClose();