Windows.Networking.BackgroundTransfer Windows.Networking.BackgroundTransfer Windows.Networking.BackgroundTransfer Windows.Networking.BackgroundTransfer Namespace

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.

Edit

[This namespace contains one or more prerelease APIs.]
Enables advanced download and upload transfer capabilities within an app. For an overview of Background Transfer capabilities, see Transferring data in the background. Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Note

Background transfer is primarily designed for long-term transfer operations for resources like video, music, and large images. For short-term operations involving transfers of smaller resources (i.e. a couple KB), the HTTP APIs are recommended. HttpClient is preferred and can be used in all languages supported by Windows Store app. XHR can be used in JavaScript. IXHR2 can be used in C++.

Classes

BackgroundDownloader BackgroundDownloader BackgroundDownloader BackgroundDownloader

Used to configure downloads prior to the actual creation of the download operation using CreateDownload. For an overview of Background Transfer capabilities, see Transferring data in the background. Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Note

Background Transfer is primarily designed for long-term transfer operations for resources like video, music, and large images. For short-term operations involving transfers of smaller resources (i.e. a couple KB), use the Windows.Web.Http namespace.
BackgroundTransferCompletionGroup BackgroundTransferCompletionGroup BackgroundTransferCompletionGroup BackgroundTransferCompletionGroup

Represents a set of background transfer operations (DownloadOperation or UploadOperation objects) that trigger a background task once all the operations are done (if the operations completed successfully) or fail with an error.
BackgroundTransferCompletionGroupTriggerDetails BackgroundTransferCompletionGroupTriggerDetails BackgroundTransferCompletionGroupTriggerDetails BackgroundTransferCompletionGroupTriggerDetails

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

Represents a content part of a multi-part transfer request. Each BackgroundTransferContentPart object can represent either a single string of text content or a single file payload, but not both.
BackgroundTransferError BackgroundTransferError BackgroundTransferError BackgroundTransferError

Used to provide errors encountered during a transfer operation.
BackgroundTransferGroup BackgroundTransferGroup BackgroundTransferGroup BackgroundTransferGroup

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.
BackgroundTransferRangesDownloadedEventArgs BackgroundTransferRangesDownloadedEventArgs BackgroundTransferRangesDownloadedEventArgs BackgroundTransferRangesDownloadedEventArgs

[Contains prerelease APIs.]
Provides access to information about the incremental download progress event.
BackgroundUploader BackgroundUploader BackgroundUploader BackgroundUploader

Used to configure upload prior to the actual creation of the upload operation using CreateUpload. For an overview of Background Transfer capabilities, see Transferring data in the background. Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Note

Background Transfer is primarily designed for long-term transfer operations for resources like video, music, and large images. For short-term operations involving transfers of smaller resources (i.e. a couple KB), use the Windows.Web.Http namespace.
ContentPrefetcher ContentPrefetcher ContentPrefetcher ContentPrefetcher

Provides properties for specifying web resources to be prefetched. Windows will use heuristics to attempt to download the specified resources in advance of your app being launched by the user.
DownloadOperation DownloadOperation DownloadOperation DownloadOperation

[Contains prerelease APIs.]
Performs an asynchronous download operation. The Background Transfer sample demonstrates this functionality. For an overview of Background Transfer capabilities, see Transferring data in the background. Download the Background Transfer sample for examples in JavaScript, C#, and C++.
ResponseInformation ResponseInformation ResponseInformation ResponseInformation

Represents data that is returned by a server response.
UnconstrainedTransferRequestResult UnconstrainedTransferRequestResult UnconstrainedTransferRequestResult UnconstrainedTransferRequestResult

Represents the result a request for unconstrained transfers from a BackgroundDownloader or BackgroundUploader object.

Unconstrained transfer operations can run without the resource restrictions normally associated with background network operations while a device running on battery.
UploadOperation UploadOperation UploadOperation UploadOperation

Performs an asynchronous upload operation. For an overview of Background Transfer capabilities, see Transferring data in the background. Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Structs

BackgroundDownloadProgress BackgroundDownloadProgress BackgroundDownloadProgress BackgroundDownloadProgress

Contains status information about the download operation.
BackgroundTransferFileRange BackgroundTransferFileRange BackgroundTransferFileRange BackgroundTransferFileRange

[Contains prerelease APIs.]
Contains status information about the file transfer operation.
BackgroundUploadProgress BackgroundUploadProgress BackgroundUploadProgress BackgroundUploadProgress

Contains status information about the upload operation.

Interfaces

IBackgroundTransferBase IBackgroundTransferBase IBackgroundTransferBase IBackgroundTransferBase

Represents a background transfer operation.
IBackgroundTransferContentPartFactory IBackgroundTransferContentPartFactory IBackgroundTransferContentPartFactory IBackgroundTransferContentPartFactory

Creates a BackgroundTransferContentPart object.
IBackgroundTransferOperation IBackgroundTransferOperation IBackgroundTransferOperation IBackgroundTransferOperation

Represents a background transfer operation.
IBackgroundTransferOperationPriority IBackgroundTransferOperationPriority IBackgroundTransferOperationPriority IBackgroundTransferOperationPriority

Use this interface to determine the priority of a downloads or uploads within a BackgroundTransferGroup. Possible values are defined by the BackgroundTransferPriority enumeration.

Enums

BackgroundTransferBehavior BackgroundTransferBehavior BackgroundTransferBehavior BackgroundTransferBehavior

Defines values used to indicate if downloads and uploads within a BackgroundTransferGroup run in simultaneously or in serial.
BackgroundTransferCostPolicy BackgroundTransferCostPolicy BackgroundTransferCostPolicy BackgroundTransferCostPolicy

Defines values used to specify whether transfers can occur on metered networks.
BackgroundTransferPriority BackgroundTransferPriority BackgroundTransferPriority BackgroundTransferPriority

Indicates the priority that a BackgroundTransfer operation(download or upload) has in terms of scheduling within an app.
BackgroundTransferStatus BackgroundTransferStatus BackgroundTransferStatus BackgroundTransferStatus

[Contains prerelease APIs.]
Defines transfer operation status values.

See Also