Share via


BackgroundTransferCompletionGroupTriggerDetails Class

Definition

Contains information about a BackgroundTransferCompletionGroup that can be only accessed from the Run method on the IBackgroundTask.

public ref class BackgroundTransferCompletionGroupTriggerDetails sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundTransferCompletionGroupTriggerDetails final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTransferCompletionGroupTriggerDetails
Public NotInheritable Class BackgroundTransferCompletionGroupTriggerDetails
Inheritance
Object Platform::Object IInspectable BackgroundTransferCompletionGroupTriggerDetails
Attributes

Windows requirements

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

Remarks

The BackgroundTransferCompletionGroup class allows an app to register to receive immediate notification after background transfer operations are complete even if the app is not in the foreground. The app registers a background task to receive notification that occurs if the background transfers completed successfully or if an error occurred. This allows the app to be immediately notified at the time of completion, instead of requiring that the app wait until the next time the app is restarted or moved to the foreground to query for completions.

The app must implement the IBackgroundTask to run that receives the completion notifications. The IBackgroundTask must be registered using the BackgroundTaskBuilder class. The background task must be declared in the app manifest. The app does not require lock screen access to use a BackgroundTransferCompletionGroup.

A BackgroundTransferCompletionGroupTriggerDetails instance is created when the background task for a BackgroundTransferCompletionGroup has received a notification after background transfer operations are complete.

Properties

Downloads

Gets the list of DownloadOperation objects associated with the BackgroundTransferCompletionGroup.

Uploads

Gets the list of UploadOperation objects associated with the BackgroundTransferCompletionGroup.

Applies to

See also