Class Channel

Hierarchy

TypedEventEmitter<ChannelEvents, this>
- Channel

Constructors

constructor

new Channel(): Channel
Returns Channel
Inherited from (EventEmitter as new () => TypedEmitter<ChannelEvents>).constructor

Properties

`Readonly`accountSid

accountSid: string

`Readonly`assignedTasks

assignedTasks: number

`Readonly`available

available: boolean

`Readonly`availableCapacityPercentage

availableCapacityPercentage: number

`Readonly`capacity

capacity: number

`Readonly`dateCreated

dateCreated: Date

`Readonly`dateUpdated

dateUpdated: Date

`Readonly`lastReservedTime

lastReservedTime: Date

`Readonly`sid

sid: string

`Readonly`taskChannelSid

taskChannelSid: string

`Readonly`taskChannelUniqueName

taskChannelUniqueName: string

`Readonly`workerSid

workerSid: string

`Readonly`workspaceSid

workspaceSid: string

Methods

addListener

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

emit

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

eventNames

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

getMaxListeners

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

listenerCount

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

listeners

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

off

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

on

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

once

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

prependListener

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

prependOnceListener

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

rawListeners

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

removeAllListeners

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

removeListener

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

setMaxListeners

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