WebUIDeviceActivatedEventArgs WebUIDeviceActivatedEventArgs WebUIDeviceActivatedEventArgs WebUIDeviceActivatedEventArgs Class

Definition

Provides information for a device that invokes AutoPlay.

public : sealed class WebUIDeviceActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IDeviceActivatedEventArgs, IActivatedEventArgsDeferral
public sealed class WebUIDeviceActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IDeviceActivatedEventArgs, IActivatedEventArgsDeferral
Public NotInheritable Class WebUIDeviceActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IDeviceActivatedEventArgs, 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)

Remarks

This object is accessed when you implement an event handler for the WinJS.Application.Onactivated or the Windows.UI.WebUI.WebUIApplication.activated events when ActivationKind is device.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX)

.

Properties

ActivatedOperation ActivatedOperation ActivatedOperation ActivatedOperation

Gets the app activated operation.

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

CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId CurrentlyShownApplicationViewId

Gets the identifier for the currently shown app view.

public : int CurrentlyShownApplicationViewId { get; }
public int CurrentlyShownApplicationViewId { get; }
Public ReadOnly Property CurrentlyShownApplicationViewId As int
var int = webuiDeviceActivatedEventArgs.currentlyShownApplicationViewId;
Value
int int int int

The identifier for the currently shown app view.

DeviceInformationId DeviceInformationId DeviceInformationId DeviceInformationId

Gets the device identifier for the device that invoked AutoPlay.

public : Platform::String DeviceInformationId { get; }
public string DeviceInformationId { get; }
Public ReadOnly Property DeviceInformationId As string
var string = webuiDeviceActivatedEventArgs.deviceInformationId;
Value
Platform::String string string string

The device identifier for the device that invoked AutoPlay.

Kind Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }
public ActivationKind Kind { get; }
Public ReadOnly Property Kind As ActivationKind
var activationKind = webuiDeviceActivatedEventArgs.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 = webuiDeviceActivatedEventArgs.previousExecutionState;

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 = webuiDeviceActivatedEventArgs.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 = webuiDeviceActivatedEventArgs.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.

Verb Verb Verb Verb

Gets the action associated with the activated device.

public : Platform::String Verb { get; }
public string Verb { get; }
Public ReadOnly Property Verb As string
var string = webuiDeviceActivatedEventArgs.verb;
Value
Platform::String string string string

The action associated with the activated device.