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

    Interface Channel

    interface Channel {
        accountSid: string;
        assignedTasks: number;
        available: boolean;
        availableCapacityPercentage: number;
        capacity: number;
        dateCreated: Date;
        dateUpdated: Date;
        lastReservedTime: Date;
        sid: string;
        taskChannelSid: string;
        taskChannelUniqueName: string;
        workerSid: string;
        workspaceSid: string;
        addListener<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        emit<E extends keyof ChannelEvents>(
            event: E,
            ...args: Parameters<ChannelEvents[E]>,
        ): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount<E extends keyof ChannelEvents>(event: E): number;
        listeners<E extends keyof ChannelEvents>(event: E): ChannelEvents[E][];
        off<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        on<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        once<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        prependListener<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        prependOnceListener<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        rawListeners<E extends keyof ChannelEvents>(event: E): ChannelEvents[E][];
        removeAllListeners<E extends keyof ChannelEvents>(event?: E): this;
        removeListener<E extends keyof ChannelEvents>(
            event: E,
            listener: ChannelEvents[E],
        ): this;
        setMaxListeners(maxListeners: number): this;
    }

    Hierarchy

    Index

    Properties

    accountSid: string
    assignedTasks: number
    available: boolean
    availableCapacityPercentage: number
    capacity: number
    dateCreated: Date
    dateUpdated: Date
    lastReservedTime: Date
    sid: string
    taskChannelSid: string
    taskChannelUniqueName: string
    workerSid: string
    workspaceSid: string

    Methods

    • Type Parameters

      Parameters

      Returns boolean

    • Returns (string | symbol)[]

    • Returns number

    • Type Parameters

      Parameters

      • event: E

      Returns number

    • Type Parameters

      Parameters

      Returns this

    • Type Parameters

      Parameters

      Returns this

    • Type Parameters

      Parameters

      • Optionalevent: E

      Returns this

    • Type Parameters

      Parameters

      Returns this

    • Parameters

      • maxListeners: number

      Returns this