Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Windows.Networking.BackgroundTransfer namespace

Applies to Windows and Windows Phone

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 apps. XHR can be used in JavaScript. IXHR2 can be used in C++.

Members

The Windows.Networking.BackgroundTransfer namespace has these types of members:

Classes

The Windows.Networking.BackgroundTransfer namespace has these classes.

ClassDescription
BackgroundDownloader Used to configure downloads prior to the actual creation of the download operation using CreateDownload.
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 Used to provide errors encountered during a transfer operation.
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.
BackgroundUploader Used to configure upload prior to the actual creation of the upload operation using CreateUpload.
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 Performs an asynchronous download operation. The Background Transfer sample demonstrates this functionality.
ResponseInformation Represents data that is returned by a server response.
UnconstrainedTransferRequestResult Represents the result a request for unconstrained transfers from a BackgroundDownloader or BackgroundUploader object.
UploadOperation Performs an asynchronous upload operation.

 

Enumerations

The Windows.Networking.BackgroundTransfer namespace has these enumerations.

EnumerationDescription
BackgroundTransferBehavior Defines values used to indicate if downloads and uploads within a BackgroundTransferGroup run in simultaneously or in serial.
BackgroundTransferCostPolicy Defines values used to specify whether transfers can occur on metered networks.
BackgroundTransferPriority Defines the values used to indicate the priority of a download or upload operation when within a BackgroundTransferGroup.
BackgroundTransferStatus Defines transfer operation status values.

 

Interfaces

The Windows.Networking.BackgroundTransfer namespace defines these interfaces.

InterfaceDescription
IBackgroundTransferBase Represents a background transfer operation.
IBackgroundTransferContentPartFactory Creates a BackgroundTransferContentPart object.
IBackgroundTransferOperation Represents a background transfer operation.
IBackgroundTransferOperationPriority Use this interface to determine the priority of a downloads or uploads within a BackgroundTransferGroup. Possible values are defined by the BackgroundTransferPriority enumeration.

 

Structures

The Windows.Networking.BackgroundTransfer namespace has these structures.

StructureDescription
BackgroundDownloadProgress Contains status information about the download operation.
BackgroundUploadProgress Contains status information about the upload operation.

 

Remarks

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

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

Other resources
Adding support for networking
How to configure network isolation capabilities
Quickstart: Downloading a file
Quickstart: Uploading a file
Transferring a file from a network resource
Transferring data in the background
Reference
HttpClient
IXHR2
Windows.Storage
XHR
Samples
Background Transfer sample

 

 

Show:
© 2014 Microsoft