WebUIToastNotificationActivatedEventArgs WebUIToastNotificationActivatedEventArgs WebUIToastNotificationActivatedEventArgs WebUIToastNotificationActivatedEventArgs Class

Definition

Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

public : sealed class WebUIToastNotificationActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IToastNotificationActivatedEventArgs, IActivatedEventArgsDeferralpublic sealed class WebUIToastNotificationActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IToastNotificationActivatedEventArgs, IActivatedEventArgsDeferralPublic NotInheritable Class WebUIToastNotificationActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IToastNotificationActivatedEventArgs, IActivatedEventArgsDeferral// You can use this class in JavaScript.
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// You can use this property in JavaScript.

Argument Argument Argument Argument

Gets the arguments that the app can retrieve after it is activated through an interactive toast notification.

public : PlatForm::String Argument { get; }public string Argument { get; }Public ReadOnly Property Argument As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value:

  • The arguments attribute of the action element, if the user performs an action inside the interactive toast notification.
  • The launch attribute of the toast element, if the user simply clicks the body of the toast notification.

Kind Kind Kind Kind

Gets the kind of activation.

public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind// You can use this property in JavaScript.

PreviousExecutionState PreviousExecutionState PreviousExecutionState PreviousExecutionState

Gets the previous execution state of the app.

public : ApplicationExecutionState PreviousExecutionState { get; }public ApplicationExecutionState PreviousExecutionState { get; }Public ReadOnly Property PreviousExecutionState As ApplicationExecutionState// You can use this property in JavaScript.

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// You can use this property in JavaScript.
Value
SplashScreen SplashScreen SplashScreen SplashScreen

The splash screen object.

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// You can use this property in JavaScript.
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.

UserInput UserInput UserInput UserInput

Gets a set of values that you can use to obtain the user input from an interactive toast notification.

public : ValueSet UserInput { get; }public ValueSet UserInput { get; }Public ReadOnly Property UserInput As ValueSet// You can use this property in JavaScript.
Value
ValueSet ValueSet ValueSet ValueSet

A set of values that you can use to obtain the user input from an interactive toast notification. This information consists of pairs of keys and values, in which the keys are the identifiers for the input elements for which the user provided input and the values represent the input from the user. For input elements that specify that the type of the input is text, the value is the string that the user specified. For input elements that specify that the type of the input is an item that the user selects from a predefined list, the value is the identifier for the item that the user selected.