Protocol​Activated​Event​Args Protocol​Activated​Event​Args Protocol​Activated​Event​Args Class

Definition

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

JavaScript This type appears as WebUIProtocolActivatedEventArgs.

public : sealed class ProtocolActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProviderpublic sealed class ProtocolActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProviderPublic NotInheritable Class ProtocolActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProvider
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

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

public partial class App
{
   protected override void OnActivated(IActivatedEventArgs args)
   {
      if (args.Kind == ActivationKind.Protocol)
      {
         ProtocolActivatedEventArgs eventArgs = args as ProtocolActivatedEventArgs;

         // TODO: Handle URI activation
         // The received URI is eventArgs.Uri.AbsoluteUri
      }
   }
}
Private Sub OnFileActivated(ByVal args As Windows.ApplicationModel.Activation.IActivatedEventArgs)
   If args.Kind = ActivationKind.Protocol Then
      ProtocolActivatedEventArgs eventArgs = args As ProtocolActivatedEventArgs

      ' TODO: Handle URI activation
      ' The received URI is eventArgs.Uri.AbsoluteUri
   End If
End Sub
void App::OnActivated(Windows::ApplicationModel::Activation::IActivatedEventArgs^ args)
{
   if (args->Kind == Windows::ApplicationModel::Activation::ActivationKind::Protocol)
   {
      Windows::ApplicationModel::Activation::ProtocolActivatedEventArgs^ eventArgs = 
          dynamic_cast<Windows::ApplicationModel::Activation::ProtocolActivatedEventArgs^>(args);

      // TODO: Handle URI activation  
      // The received URI is eventArgs->Uri->RawUri
   } 
}

Remarks

This object is accessed when you implement an event handler to respond to Activated events when ActivationKind is Protocol.

Windows Store app using C++, C#, or Visual Basic typically implement activation points by overriding methods of the Application object. The default template app.xaml code-behind files always include an override for OnLaunched, but defining overrides for other activation points such as OnActivated is up to your app code. If ActivationKind is Protocol then the interface-typed IActivatedEventArgs from OnActivated can be cast to ProtocolActivatedEventArgs.

All Application overrides involved in an activation scenario should call Window.Activate in their implementations.

Properties

CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName

Gets the package family name of the application that activated the current application.

public : PlatForm::String CallerPackageFamilyName { get; }public string CallerPackageFamilyName { get; }Public ReadOnly Property CallerPackageFamilyName As string
Value
PlatForm::String string string

The package family name of the application that activated the current application.

Attributes

Remarks

If the caller is a non-packaged app (such as a Win32 app), CallerPackageFamilyName will be empty, that is "".

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
Value
int int int

The identifier for the currently shown app view.

Attributes

Data Data Data

Data received from the application that activated the current application.

public : ValueSet Data { get; }public ValueSet Data { get; }Public ReadOnly Property Data As ValueSet
Value
ValueSet ValueSet ValueSet

User-defined data. May be null.

Attributes

Kind Kind Kind

Gets the activation type.

public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind
Value
ActivationKind ActivationKind ActivationKind

One of the enumeration values.

Attributes
See Also

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
Attributes
See Also

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
Value
SplashScreen SplashScreen SplashScreen

The object that provides splash screen information.

Attributes
See Also

Uri Uri Uri

Gets the Uniform Resource Identifier (URI) for which the app was activated.

public : Uri Uri { get; }public Uri Uri { get; }Public ReadOnly Property Uri As Uri
Value
Uri Uri Uri

The Uniform Resource Identifier (URI).

Attributes
See Also

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
Value
User User User

The user that the app was activated for.

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

ViewSwitcher ViewSwitcher ViewSwitcher

Gets the view switcher object that allows you to set the view for the application.

public : ActivationViewSwitcher ViewSwitcher { get; }public ActivationViewSwitcher ViewSwitcher { get; }Public ReadOnly Property ViewSwitcher As ActivationViewSwitcher
Value
ActivationViewSwitcher ActivationViewSwitcher ActivationViewSwitcher

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be null in hosted scenarios such as Share and File Picker activations.

Attributes

See Also