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

    Interface Reservation

    interface Reservation {
        accountSid: string;
        canceledReasonCode?: number;
        dateCreated: Date;
        dateUpdated: Date;
        sid: string;
        status:
            | "completed"
            | "canceled"
            | "rejected"
            | "pending"
            | "accepted"
            | "timeout"
            | "rescinded"
            | "wrapping";
        task: Task;
        timeout: number;
        version: string;
        workerSid: string;
        workspaceSid: string;
        accept(): Promise<Reservation>;
        addListener<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        call(
            from: string,
            url: string,
            options?: CallOptions,
        ): Promise<Reservation>;
        complete(): Promise<Reservation>;
        conference(options?: ConferenceOptions): Promise<Reservation>;
        dequeue(options?: DequeueOptions): Promise<Reservation>;
        emit<E extends keyof ReservationEvents>(
            event: E,
            ...args: Parameters<ReservationEvents[E]>,
        ): boolean;
        eventNames(): (string | symbol)[];
        fetchLatestVersion(): Promise<Reservation>;
        getMaxListeners(): number;
        listenerCount<E extends keyof ReservationEvents>(event: E): number;
        listeners<E extends keyof ReservationEvents>(
            event: E,
        ): ReservationEvents[E][];
        off<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        on<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        once<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        prependListener<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        prependOnceListener<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        rawListeners<E extends keyof ReservationEvents>(
            event: E,
        ): ReservationEvents[E][];
        redirect(
            callSid: string,
            url: string,
            options?: RedirectOptions,
        ): Promise<Reservation>;
        reject(options?: RejectOptions): Promise<Reservation>;
        removeAllListeners<E extends keyof ReservationEvents>(event?: E): this;
        removeListener<E extends keyof ReservationEvents>(
            event: E,
            listener: ReservationEvents[E],
        ): this;
        setMaxListeners(maxListeners: number): this;
        updateParticipant(
            options: ReservationParticipantOptions,
        ): Promise<Reservation>;
        wrap(): Promise<Reservation>;
    }

    Hierarchy

    Index

    Properties

    accountSid canceledReasonCode? dateCreated dateUpdated sid status task timeout version workerSid workspaceSid

    Methods

    accept addListener call complete conference dequeue emit eventNames fetchLatestVersion getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners redirect reject removeAllListeners removeListener setMaxListeners updateParticipant wrap

    Properties

    accountSid: string
    canceledReasonCode?: number
    dateCreated: Date
    dateUpdated: Date
    sid: string
    status:
        | "completed"
        | "canceled"
        | "rejected"
        | "pending"
        | "accepted"
        | "timeout"
        | "rescinded"
        | "wrapping"
    task: Task
    timeout: number
    version: string
    workerSid: string
    workspaceSid: string

    Methods

    • Returns (string | symbol)[]

    • Returns number

    • Type Parameters

      Parameters

      • event: E

      Returns number

    • Type Parameters

      Parameters

      • Optionalevent: E

      Returns this

    • Parameters

      • maxListeners: number

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods