Logout

Log out of all Symphony instances

The logout function exposed by the SDK allows you to log the user out of all Symphony instances. The function is available in Focus and Collaboration modes.

When called, the function will log the user out of Symphony servers, and then delete all the iFrames controlled by our SDK.

Once logged out, Symphony is back in a state as if the first render method had never been called so any other function provided by the SDK would not have any effect. The render method needs to be called again.

window.symphony.logout(): Promise<{error?: {type: string; message: string}}>;

Returned Promise

The Logout function returns a JavaScript Promise that will resolve once the action has been completed. The promise has the following interface:

- Success: {}

- Error:

Parameter	Type	Description
type	string	Type of error: ERROR for generic errors
message	string	Description of the error
data	Object | undefined	Additional data on the error, if any.

Use with caution: This function logs the user out of all the Symphony instances of their current browser. So if the user is logged in Embedded Mode from two web apps (yours, and another one), then you will log them out of the two apps.