ConversationalAgentSession.RequestActivationAsync Method

Reference

Definition

Namespace:: Windows.ApplicationModel.ConversationalAgent

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Asynchronously requests that the digital assistant be activated to the foreground.

public:
 virtual IAsyncOperation<ConversationalAgentActivationResult> ^ RequestActivationAsync(ConversationalAgentActivationKind activationKind) = RequestActivationAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<ConversationalAgentActivationResult> RequestActivationAsync(ConversationalAgentActivationKind const& activationKind);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<ConversationalAgentActivationResult> RequestActivationAsync(ConversationalAgentActivationKind activationKind);

function requestActivationAsync(activationKind)

Public Function RequestActivationAsync (activationKind As ConversationalAgentActivationKind) As IAsyncOperation(Of ConversationalAgentActivationResult)

Parameters

activationKind: ConversationalAgentActivationKind

The supported agent activation type.

When activation is requested, you can choose whether the agent is activated in a voice activation preview window or normal window.

Returns

IAsyncOperation<ConversationalAgentActivationResult>

The result of the activation.

Attributes: RemoteAsyncAttribute

Windows requirements

Device family	Windows 11 (introduced in 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v14.0)

Remarks

This is an updated version of the RequestForegroundActivationAsync method.

Applies to

Jaa