Relay.Calling.FaxAction

This object returned from fax_receive_async and fax_send_async 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`	dict	Payload sent to Relay to start faxing.
`control_id`	string	UUID to identify the fax action.

Methods

stop

Stop the action immediately.

Parameters

None

Returns

coroutine - Coroutine that will return a Relay.Calling.StopResult object.

Examples

Start sending fax and stop it after 5 seconds.

1 import asyncio # to use sleep
2 
3 action = await call.fax_send_async('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')
4 # For demonstration purposes only..
5 await asyncio.sleep(5)
6 await action.stop()