Share via


ConversationalAgentSession.RequestInterruptible(Boolean) Method

Definition

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

Important

To avoid possible concurrency issues, we recommend using RequestInterruptibleAsync instead.

public:
 virtual ConversationalAgentSessionUpdateResponse RequestInterruptible(bool interruptible) = RequestInterruptible;
ConversationalAgentSessionUpdateResponse RequestInterruptible(bool const& interruptible);
public ConversationalAgentSessionUpdateResponse RequestInterruptible(bool interruptible);
function requestInterruptible(interruptible)
Public Function RequestInterruptible (interruptible As Boolean) As ConversationalAgentSessionUpdateResponse

Parameters

interruptible
Boolean

bool

True, if interruptible; otherwise, false.

Returns

A ConversationalAgentSessionUpdateResponse.

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

See also