Relay::Calling::DetectAction

This object returned from the asynchronous detect! methods that represents a running detector on the call.

Properties

Property	Type	Description
result	Relay::Calling::DetectResult	Final detector result.
completed	boolean	Whether the action has finished.
payload	object	Payload sent to Relay to start this detector.
controlId	string	UUID to identify the detector.

Methods

stop

Stop the action immediately.

Parameters

None

Returns

Relay::Calling::StopResult - A StopResult object with a successful property.

Examples

Detect a machine on the current call. Stop the action after 5 seconds.

action = call.detect!(type: :machine)
sleep 5
action.stop