Share via


ConversationalAgentSession.RequestInterruptibleAsync(Boolean) Method

Definition

Asynchronously requests that this ConversationalAgentSession be interruptible if the keyword for another digital assistant is detected.

public:
 virtual IAsyncOperation<ConversationalAgentSessionUpdateResponse> ^ RequestInterruptibleAsync(bool interruptible) = RequestInterruptibleAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<ConversationalAgentSessionUpdateResponse> RequestInterruptibleAsync(bool const& interruptible);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<ConversationalAgentSessionUpdateResponse> RequestInterruptibleAsync(bool interruptible);
function requestInterruptibleAsync(interruptible)
Public Function RequestInterruptibleAsync (interruptible As Boolean) As IAsyncOperation(Of ConversationalAgentSessionUpdateResponse)

Parameters

interruptible
Boolean

bool

True, if interruptible; otherwise, false.

Returns

The result of the asynchronous operation as a ConversationalAgentSessionUpdateResponse.

Attributes

Remarks

Some digital assistant sessions cannot be interrupted by another signal. For example, Cortana requires the user to issue a cancel or stop command to end the current session (the user cannot be in a Cortana session and issue commands to Alexa).

If a session can be interrupted, the Windows Conversational Agent platform raises the SessionInterrupted event to indicate that the digital assistant app should set itself to inactive and stop processing input.

Applies to