BackgroundTransferGroup class

Applies to Windows and Windows Phone

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.

Syntax


var backgroundTransferGroup = Windows.Networking.BackgroundTransfer.BackgroundTransferGroup;

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]

Members

The BackgroundTransferGroup class has these types of members:

Methods

The BackgroundTransferGroup class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
CreateGroup Creates a transfer group using the provided group name.

 

Properties

The BackgroundTransferGroup class has these properties.

PropertyAccess typeDescription

Name

Read-onlyGets the name of the group.

TransferBehavior

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

 

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  

Windows 8.1 and Windows Server 2012 R2 support a maximum of 50 unique transfer groups for the entire system. So an app should reuse a unique ID or a small number of unique IDs for all transfer groups created by the app. If more than 50 transfer groups are created on the system, the app will get in an unrecoverable state.

Requirements

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Networking.BackgroundTransfer
Windows::Networking::BackgroundTransfer [C++]

Metadata

Windows.winmd

See also

Object

 

 

Show:
© 2014 Microsoft