Relay.Calling.DetectAction

This object returned from one of 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

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

Examples

Trying to detect a machine and stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectMachineAsync()

  // For demonstration purposes only..
  setTimeout(async () => {
    const stopResult = await detectAction.stop()
  }, 5000)
}

main().catch(console.error)