WebUIVoiceCommandActivatedEventArgs WebUIVoiceCommandActivatedEventArgs WebUIVoiceCommandActivatedEventArgs WebUIVoiceCommandActivatedEventArgs Class

Definition

Provides information about an activated event raised when the app is activated from a voice command.

public : sealed class WebUIVoiceCommandActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IVoiceCommandActivatedEventArgs, IActivatedEventArgsDeferral
public sealed class WebUIVoiceCommandActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IVoiceCommandActivatedEventArgs, IActivatedEventArgsDeferral
Public NotInheritable Class WebUIVoiceCommandActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IVoiceCommandActivatedEventArgs, IActivatedEventArgsDeferral
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activation operation.

public : ActivatedOperation ActivatedOperation { get; }
public ActivatedOperation ActivatedOperation { get; }
Public ReadOnly Property ActivatedOperation As ActivatedOperation
var activatedOperation = webuiVoiceCommandActivatedEventArgs.activatedOperation;

Kind Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }
public ActivationKind Kind { get; }
Public ReadOnly Property Kind As ActivationKind
var activationKind = webuiVoiceCommandActivatedEventArgs.kind;
Value
ActivationKind ActivationKind ActivationKind ActivationKind

One of the enumeration values.

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

Gets the execution state of the app before it was activated.

public : ApplicationExecutionState PreviousExecutionState { get; }
public ApplicationExecutionState PreviousExecutionState { get; }
Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState
var applicationExecutionState = webuiVoiceCommandActivatedEventArgs.previousExecutionState;

Result Result Result Result

Gets the SpeechRecognitionResult object representing the voice command that activated the app.

public : SpeechRecognitionResult Result { get; }
public SpeechRecognitionResult Result { get; }
Public ReadOnly Property Result As SpeechRecognitionResult
var speechRecognitionResult = webuiVoiceCommandActivatedEventArgs.result;
Value
SpeechRecognitionResult SpeechRecognitionResult SpeechRecognitionResult SpeechRecognitionResult

The SpeechRecognitionResult object representing the voice commands that activated the app.

SplashScreen SplashScreen SplashScreen SplashScreen

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

public : SplashScreen SplashScreen { get; }
public SplashScreen SplashScreen { get; }
Public ReadOnly Property SplashScreen As SplashScreen
var splashScreen = webuiVoiceCommandActivatedEventArgs.splashScreen;
Value
SplashScreen SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

User User User User

Gets the user that the app was activated for.

public : User User { get; }
public User User { get; }
Public ReadOnly Property User As User
var user = webuiVoiceCommandActivatedEventArgs.user;
Value
User User User User

The user that the app was activated for.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for.

This property returns null when a multi-user application is activated with no specific user context.

Multi-user apps can use this property to allow or restrict app behavior. For example, you might restrict access to content or features based on the user’s credentials.