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

    Interface Client

    Main interface for interacting with the Flex SDK.

    interface Client {
        getWorker: () => Promise<Supervisor>;
        getWorkspace: () => Promise<Workspace>;
        roles: string[];
        token: string;
        addListener<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        destroy(): void;
        emit<E extends keyof ClientEventsType>(
            event: E,
            ...args: Parameters<ClientEventsType[E]>,
        ): boolean;
        eventNames(): (symbol | (keyof ClientEventsType))[];
        execute<T>(action: Action<T>): T;
        getMaxListeners(): number;
        listenerCount<E extends keyof ClientEventsType>(event: E): number;
        listeners<E extends keyof ClientEventsType>(
            event: E,
        ): ClientEventsType[E][];
        off<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        on<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        once<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        prependListener<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        prependOnceListener<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        rawListeners<E extends keyof ClientEventsType>(
            event: E,
        ): ClientEventsType[E][];
        removeAllListeners<E extends keyof ClientEventsType>(event?: E): this;
        removeListener<E extends keyof ClientEventsType>(
            event: E,
            listener: ClientEventsType[E],
        ): this;
        setMaxListeners(maxListeners: number): this;
        updateToken(token: string): void;
    }

    Hierarchy

    Index

    Properties

    getWorker getWorkspace roles token

    Methods

    addListener destroy emit eventNames execute getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners updateToken

    Properties

    getWorker: () => Promise<Supervisor>

    Type declaration

      • (): Promise<Supervisor>

      • Returns Promise<Supervisor>

        Worker object representing the current user. If the worker is already initialized, it will return immediately.

    getWorkspace: () => Promise<Workspace>

    Type declaration

      • (): Promise<Workspace>

      • Returns Promise<Workspace>

        Workspace object. If the workspace is already initialized, it will return immediately.

    roles: string[]
    token: string

    Methods

    • Destroy the client, removing all event listeners

      Returns void

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

      const client = await createClient("SDK_TOKEN");

      await client.destroy();

    • Returns (symbol | (keyof ClientEventsType))[]

    • Returns number

    • Type Parameters

      Parameters

      • event: E

      Returns number

    • Type Parameters

      Parameters

      • Optionalevent: E

      Returns this

    • Parameters

      • maxListeners: number

      Returns this

    • Update the token for the client

      Parameters

      • token: string

        The new token

      Returns void

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

      const client = await createClient("SDK_TOKEN");

      client.updateToken("NEW_TOKEN");

    Settings

    Member Visibility

    On This Page

    Properties
    Methods