Class DialCreator

Builds a dial command. to is required.

Index

Constructors

Methods

build from maxDurationSeconds name onAnswer onBusy onFailure onHangup onReject onTimeout timeoutDurationSeconds to

Constructors

constructor

new DialCreator(): DialCreator
Returns DialCreator

Methods

build

build(): DialCommand
Returns DialCommand

from

from(from: BaseDestination | CallOrigin): this
Accepts a call origin, or a BaseDestination from Destination.of.
Parameters
- from: BaseDestination | CallOrigin
Returns this

maxDurationSeconds

maxDurationSeconds(seconds: number): this
Maps to maxCallDurationSeconds on the dial command.
Parameters
- seconds: number
Returns this

name

name(name: string): this
Maps to callName on the dial command.
Parameters
- name: string
Returns this

onAnswer

onAnswer(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

onBusy

onBusy(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

onFailure

onFailure(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

onHangup

onHangup(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

onReject

onReject(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

onTimeout

onTimeout(build: CommandInput): this
Parameters
- build: CommandInput
Returns this

timeoutDurationSeconds

timeoutDurationSeconds(seconds: number): this
Maps to dialTimeoutDurationSeconds on the dial command.
Parameters
- seconds: number
Returns this

to

to(to: CallDestination): this
Parameters
- to: CallDestination
Returns this