Relay.Calling.FaxAction

This object returned from faxReceiveAsync and faxSendAsync methods represents a receiving or sending Fax on the call.

Properties

Property	Type	Description
`result`	`Relay.Calling.FaxResult`	Final result for the fax action
`completed`	`boolean`	Whether the action has finished
`payload`	`object`	Payload sent to Relay to start faxing
`controlId`	`string`	UUID to identify the fax action

Methods

stop

Stop the action immediately.

Parameters

None

Returns

Promise<StopResult> - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Start sending fax and stop it after 5 seconds.

1 async function main() {
2   const faxAction = await call.faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')
3 
4   // For demonstration purposes only..
5   setTimeout(async () => {
6     const stopResult = await faxAction.stop()
7   }, 5000)
8 }
9 
10 main().catch(console.error)