BackgroundTransferGroup Class

Definition

A named group used to associate multiple download or upload operations. This class makes it easy for your app to create these groups and to complete downloads and uploads simultaneously, in serial, or based on priority.

For example, if a user decides to download and watch episodes from a popular television series, your app can prioritize the earliest episodes in the series or let the user choose which episode to download first.

public ref class BackgroundTransferGroup sealed
class BackgroundTransferGroup sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.Networking.BackgroundTransfer.IBackgroundTransferGroupStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTransferGroup
[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)]
[Windows.Foundation.Metadata.Static(typeof(Windows.Networking.BackgroundTransfer.IBackgroundTransferGroupStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class BackgroundTransferGroup
Public NotInheritable Class BackgroundTransferGroup
Inheritance
BackgroundTransferGroup
Attributes

Windows 10 requirements

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

Remarks

A BackgroundTransferGroup object can persist to support transfer operations that span app sessions. New methods have been introduced to BackgroundDownloader, BackgroundUploader, DownloadOperation, and UploadOperation to simplify accessing groups created in a previous app session.

Note

Up to 50 unique transfer groups per app are supported.

Properties

Name

Gets the name of the group.

TransferBehavior

Gets or sets the property used to specify if transfers within this group run simultaneously or in serial. Possible values are defined by BackgroundTransferBehavior.

Methods

CreateGroup(String)

Creates a transfer group using the provided group name.

Applies to