@twilio/flex-sdk
    Preparing search index...

    Enumeration ClientEvent

    Enumeration of event names that the Flex SDK client can emit.

    Index

    Enumeration Members

    ClientDestroyed ConnectionStateChanged TokenAboutToExpire TokenAutoUpdateFailed TokenExpired TokenMaxLifetimeReached TokenUpdated

    Enumeration Members

    ClientDestroyed: "clientDestroyed"

    Fired when the client has been destroyed via Client.destroy. All event listeners are removed after this event is emitted.

    ConnectionStateChanged: "connectionStateChanged"

    Fired when the aggregate connection state of the SDK changes — reflecting network health and the state of any initialized SDKs (Conversations, Voice, TaskRouter). The handler receives the new SdkConnectionState.

    TokenAboutToExpire: "tokenAboutToExpire"

    Fired approximately one minute before the session token expires, giving the application a window to supply a fresh token via Client.updateToken. The threshold matches the SDK's internal auto-refresh window. Emitted at most once per token.

    This fires whether or not auto-refresh (autoUpdateToken) is enabled, so applications that manage token refresh themselves can renew the token in time. The handler receives the Date at which the token will expire.

    import { createClient, ClientEvent } from "@twilio/flex-sdk";

    const client = await createClient("SDK_TOKEN", { session: { autoUpdateToken: false } });

    client.on(ClientEvent.TokenAboutToExpire, async (dateExpiring) => {
      const freshToken = await fetchNewToken();
      client.updateToken(freshToken);
    });
    TokenAutoUpdateFailed: "tokenAutoUpdateFailed"

    Fired when automatic token refresh (autoUpdateToken) fails to obtain or apply a new token. The existing token stays in place until it is replaced or expires.

    TokenExpired: "tokenExpired"

    Fired when the session token has passed its expiry time without a valid replacement having been applied. Emitted at most once per token.

    When auto-refresh (autoUpdateToken) is enabled and renews the token before expiry, this event does not fire. It is primarily useful for applications that manage token refresh themselves, or that need to react to an expired session (for example, by prompting the user to re-authenticate). The handler receives the Date at which the token expired.

    import { createClient, ClientEvent } from "@twilio/flex-sdk";

    const client = await createClient("SDK_TOKEN");

    client.on(ClientEvent.TokenExpired, (dateExpired) => {
      // The session is no longer valid; prompt the user to re-authenticate.
    });
    TokenMaxLifetimeReached: "tokenMaxLifetimeReached"

    Fired when a refresh can no longer extend the token's expiry because its maximum lifetime has been reached. The handler receives the Date at which the token expires.

    TokenUpdated: "tokenUpdated"

    Fired after the session token is updated — either by a manual Client.updateToken call or a successful auto-refresh — and propagated to all connected services. The handler receives the new token and, when available, the new refresh token.

    Settings

    Member Visibility

    On This Page

    Enumeration Members