Skip to main content

SignalWire.Relay.Calling.FaxAction

This object returned from [FaxReceiveAsync] and FaxSendAsync methods that represents a fax operation that is currently active on a call.

Properties

PropertyTypeDescription
ControlIDstringThe identifier used to control the operation.
ResultSignalWire.Relay.Calling.FaxResultFinal result of the fax operation.
CompletedboolWhether the fax operation has completed.
PayloadSignalWire.Relay.Calling.SendFaxPayloadPayload sent to FaxSend to perform a fax operation. This field will be null for receive fax operations.

Methods

Stop

Stop the action immediately.

Parameters

None

Returns

SignalWire.Relay.Calling.StopResult - The result object to interact with.

Examples

Start listening for faxes and stop it after 5 seconds.

FaxAction actionFax = call.FaxReceiveAsync();

Thread.Sleep(5000);

StopResult resultStop = actionFax.Stop();