Relay.Calling.PromptAction
Relay.Calling.PromptAction
This object returned from one of asynchronous prompt methods that represents a prompt attempt that is currently active on a call.
Methods-submenu
GetResult
Returns the final result of the prompt attempt.
Parameters
None
Returns
Relay.Calling.PromptResult - Final result of the prompt attempt.
Examples
Start the attempt and grab the result when it’s completed.
GetCompleted
Return true if the prompt attempt has finished, false otherwise.
Parameters
None
Returns
Boolean - True/False accordingly to the state.
Examples
Start the attempt and check if it has finished.
Stop
Stop the action immediately.
Parameters
None
Returns
error
Examples
Start the attempt and then stop it.
Volume
Control the volume of the playback.
Parameters
Returns
error
Examples
Start the prompt and increase the playback volume with 5 dB
GetControlID
Return the UUID to identify the action.
Parameters
None
Returns
string - UUID to identify the action.