WebUIProtocolActivatedEventArgs Class

Definition

Namespace:

Windows.UI.WebUI

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

public ref class WebUIProtocolActivatedEventArgs sealed : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IActivatedEventArgsDeferral

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class WebUIProtocolActivatedEventArgs final : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IActivatedEventArgsDeferral

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class WebUIProtocolActivatedEventArgs : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IActivatedEventArgsDeferral

Public NotInheritable Class WebUIProtocolActivatedEventArgs
Implements IActivatedEventArgsDeferral, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData

Inheritance

Object Platform::Object IInspectable WebUIProtocolActivatedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IActivatedEventArgs IApplicationViewActivatedEventArgs IProtocolActivatedEventArgs IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData IActivatedEventArgsDeferral IActivatedEventArgsWithUser

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

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

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

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

Version history

Windows version	SDK version	Value added
1607	14393	User

Properties

ActivatedOperation	Gets the app activation operation.
CallerPackageFamilyName	Gets the family name of the caller's package.
CurrentlyShownApplicationViewId	Gets the identifier for the currently shown app view.
Data	Gets the data used for activation.
Kind	Gets the activation type.
PreviousExecutionState	Gets the execution state of the app before it was activated.
SplashScreen	Gets the splash screen object that provides information about the transition from the splash screen to the activated app.
Uri	Gets the Uniform Resource Identifier (URI) for which the app was activated.
User	Gets the user that the app was activated for.

See also

• Uri
• ActivatedEventHandler
• Association launching sample
• How to handle URI activation
• Guidelines for file types and URIs
• WinJS.Application.onactivated
• Association launching sample (Windows 10)