AppServiceTriggerDetails AppServiceTriggerDetails AppServiceTriggerDetails AppServiceTriggerDetails Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents details associated with the background task for the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

public : sealed class AppServiceTriggerDetails : IAppServiceTriggerDetails, IAppServiceTriggerDetails2public sealed class AppServiceTriggerDetails : IAppServiceTriggerDetails, IAppServiceTriggerDetails2Public NotInheritable Class AppServiceTriggerDetails Implements IAppServiceTriggerDetails, IAppServiceTriggerDetails2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

To get the AppServiceTriggerDetails for an app service, use the IBackgroundTaskInstance.TriggerDetails property.

Properties

AppServiceConnection AppServiceConnection AppServiceConnection AppServiceConnection

Gets the connection to the endpoint of the other app service.

public : AppServiceConnection AppServiceConnection { get; }public AppServiceConnection AppServiceConnection { get; }Public ReadOnly Property AppServiceConnection As AppServiceConnection// You can use this property in JavaScript.
Value
AppServiceConnection AppServiceConnection AppServiceConnection AppServiceConnection

The connection to the endpoint of the other app service.

CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName CallerPackageFamilyName

Gets the name of the package family for the client app that called the background task for the app service.

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 name of the package family for the client app that called the background task for the app service.

IsRemoteSystemConnection IsRemoteSystemConnection IsRemoteSystemConnection IsRemoteSystemConnection

Gets whether the client app that called the background task for the app service is on another device.

public : PlatForm::Boolean IsRemoteSystemConnection { get; }public bool IsRemoteSystemConnection { get; }Public ReadOnly Property IsRemoteSystemConnection As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Returns true if the client app is calling from another device; false otherwise.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Name Name Name Name

Gets the name of the app service.

public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The name of the app service.

Methods

CheckCallerForCapabilityAsync(String) CheckCallerForCapabilityAsync(String) CheckCallerForCapabilityAsync(String) CheckCallerForCapabilityAsync(String)

Prerelease. Determines whether the caller of the app service has the specified capability.

public : IAsyncOperation<PlatForm::Boolean> CheckCallerForCapabilityAsync(PlatForm::String capabilityName)public IAsyncOperation<bool> CheckCallerForCapabilityAsync(String capabilityName)Public Function CheckCallerForCapabilityAsync(capabilityName As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
capabilityName
PlatForm::String String String String

The name of the capability.

Returns

True if it was possible to get the capabilities of the caller and the caller has the specified capability; false otherwise.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

This API can only be called from within an app that is marked as an app service in its manifest. One use of this function is to determine whether a caller has the specified capability and, based on that, decide whether to share the requested data, a subset of the data, or no data.

See Also