WebUIProtocolActivatedEventArgs class (Windows)

This topic has not yet been rated - Rate this topic

Provides data when an app is activated because it is the app associated with a URI scheme name.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Attributes

MarshalingBehaviorAttribute(Standard)
VersionAttribute(NTDDI_WIN8)

Members

The WebUIProtocolActivatedEventArgs class has these types of members:

Methods
Properties

Methods

The WebUIProtocolActivatedEventArgs class inherits methods from the Object class (C#/VB/C++).

Properties

The WebUIProtocolActivatedEventArgs class has these properties.

Property	Access type	Description
ActivatedOperation	Read-only	Gets the app activation operation.
Kind	Read-only	Gets the activation type.
PreviousExecutionState	Read-only	Gets the execution state of the app before it was activated.
SplashScreen	Read-only	Gets the splash screen object that provides information about the transition from the splash screen to the activated app.
Uri	Read-only	Gets the Uniform Resource Identifier (URI) for which the app was activated.

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 protocol.

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).

Examples

The activated event handler receives all activation events. The kind property indicates the type of activation event. This example is set up to handle protocol activation events.

JavaScript


function onActivatedHandler(eventArgs) {
   if (eventArgs.detail.kind == Windows.ApplicationModel.Activation.ActivationKind.protocol) 
   {
       // TODO: Handle protocol activation.

       // The received URI is eventArgs.detail.uri.rawUri
   }
}

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.WebUI
Metadata	Windows.winmd

WebUIProtocolActivatedEventArgs class