ProtocolForResultsActivatedEventArgs
ProtocolForResultsActivatedEventArgs
ProtocolForResultsActivatedEventArgs
ProtocolForResultsActivatedEventArgs
Class
Definition
Received by an application when it is launched by another application with the expectation that it will return results back to the caller.
public : sealed class ProtocolForResultsActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IProtocolForResultsActivatedEventArgs, IViewSwitcherProviderpublic sealed class ProtocolForResultsActivatedEventArgs : IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IProtocolForResultsActivatedEventArgs, IViewSwitcherProviderPublic NotInheritable Class ProtocolForResultsActivatedEventArgs Implements IActivatedEventArgs, IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IProtocolForResultsActivatedEventArgs, IViewSwitcherProvider// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
You access a ProtocolForResultsActivatedEventArgs object when you implement an event handler that responds to Activated events when ActivationKind is ProtocolForResults.
Properties
CallerPackageFamilyName 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// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The package family name of the application that activated the current application.
Remarks
If the caller is a non-packaged app (such as a Win32 app), CallerPackageFamilyName will be empty, that is "".
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// You can use this property in JavaScript.
- Value
- int int int int
The identifier for the currently shown app view.
Kind Kind Kind Kind
Gets the activation type.
public : ActivationKind Kind { get; }public ActivationKind Kind { get; }Public ReadOnly Property Kind As ActivationKind// You can use this property in JavaScript.
A enumeration value.
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// You can use this property in JavaScript.
- Value
- ApplicationExecutionState ApplicationExecutionState ApplicationExecutionState ApplicationExecutionState
An ApplicationExecutionState enumeration value.
ProtocolForResultsOperation ProtocolForResultsOperation ProtocolForResultsOperation ProtocolForResultsOperation
Gets the ProtocolForResultsOperation that you use to signal that your app is ready to return to the app that launched it for results.
public : ProtocolForResultsOperation ProtocolForResultsOperation { get; }public ProtocolForResultsOperation ProtocolForResultsOperation { get; }Public ReadOnly Property ProtocolForResultsOperation As ProtocolForResultsOperation// You can use this property in JavaScript.
- Value
- ProtocolForResultsOperation ProtocolForResultsOperation ProtocolForResultsOperation ProtocolForResultsOperation
The ProtocolForResultsOperation object that you can use to signal that your app is ready to return by calling its ProtocolForResultsOperation.ReportCompleted method.
SplashScreen SplashScreen SplashScreen SplashScreen
Gets a SplashScreen 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.
The object that provides splash screen information.
Uri Uri Uri Uri
Gets the Uniform Resource Identifier (URI) used to activate the app.
public : Uri Uri { get; }public Uri Uri { get; }Public ReadOnly Property Uri As Uri// You can use this property in JavaScript.
- Value
- Uri Uri Uri Uri
The Uniform Resource Identifier (URI).
User User User User
Gets the user 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.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
ViewSwitcher 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// You can use this property in JavaScript.
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.