Class Reservation

Hierarchy

TypedEventEmitter<ReservationEvents, this>
- Reservation

Constructors

constructor

new Reservation(): Reservation
Returns Reservation
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).constructor

Properties

`Readonly`accountSid

accountSid: string

`Optional` `Readonly`canceledReasonCode

canceledReasonCode?: number

`Readonly`dateCreated

dateCreated: Date

`Readonly`dateUpdated

dateUpdated: Date

`Readonly`sid

sid: string

`Readonly`status

status:
    | "completed"
    | "canceled"
    | "rejected"
    | "pending"
    | "accepted"
    | "timeout"
    | "rescinded"
    | "wrapping"

`Readonly`task

task: Task

`Readonly`timeout

timeout: number

`Readonly`version

version: string

`Readonly`workerSid

workerSid: string

`Readonly`workspaceSid

workspaceSid: string

Methods

accept

accept(): Promise<Reservation>
Returns Promise<Reservation>

addListener

addListener<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).addListener

call

call(from: string, url: string, options?: CallOptions): Promise<Reservation>
Parameters
- from: string
- url: string
- Optionaloptions: CallOptions
Returns Promise<Reservation>

complete

complete(): Promise<Reservation>
Returns Promise<Reservation>

conference

conference(options?: ConferenceOptions): Promise<Reservation>
Parameters
- Optionaloptions: ConferenceOptions
Returns Promise<Reservation>

dequeue

dequeue(options?: DequeueOptions): Promise<Reservation>
Parameters
- Optionaloptions: DequeueOptions
Returns Promise<Reservation>

emit

emit<E extends keyof ReservationEvents>(
event: E,
...args: Parameters<ReservationEvents[E]>,
): boolean
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- ...args: Parameters<ReservationEvents[E]>
Returns boolean
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).eventNames

fetchLatestVersion

fetchLatestVersion(): Promise<Reservation>
Returns Promise<Reservation>

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).getMaxListeners

listenerCount

listenerCount<E extends keyof ReservationEvents>(event: E): number
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).listenerCount

listeners

listeners<E extends keyof ReservationEvents>(event: E): ReservationEvents[E][]
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
Returns ReservationEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).listeners

off

off<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).off

on

on<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).on

once

once<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).once

prependListener

prependListener<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).prependListener

prependOnceListener

prependOnceListener<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).prependOnceListener

rawListeners

rawListeners<E extends keyof ReservationEvents>(
event: E,
): ReservationEvents[E][]
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
Returns ReservationEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).rawListeners

redirect

redirect(
    callSid: string,
    url: string,
    options?: RedirectOptions,
): Promise<Reservation>
Parameters
- callSid: string
- url: string
- Optionaloptions: RedirectOptions
Returns Promise<Reservation>

reject

reject(options?: RejectOptions): Promise<Reservation>
Parameters
- Optionaloptions: RejectOptions
Returns Promise<Reservation>

removeAllListeners

removeAllListeners<E extends keyof ReservationEvents>(event?: E): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- Optionalevent: E
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).removeAllListeners

removeListener

removeListener<E extends keyof ReservationEvents>(
event: E,
listener: ReservationEvents[E],
): this
Type Parameters
- E extends keyof ReservationEvents
Parameters
- event: E
- listener: ReservationEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).removeListener

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<ReservationEvents>).setMaxListeners

updateParticipant

updateParticipant(options: ReservationParticipantOptions): Promise<Reservation>
Parameters
- options: ReservationParticipantOptions
Returns Promise<Reservation>

wrap

wrap(): Promise<Reservation>
Returns Promise<Reservation>