IBackgroundTransferOperation IBackgroundTransferOperation IBackgroundTransferOperation IBackgroundTransferOperation IBackgroundTransferOperation Interface


Represents a background transfer operation.

public : interface IBackgroundTransferOperation
struct winrt::Windows::Networking::BackgroundTransfer::IBackgroundTransferOperation
public interface IBackgroundTransferOperation
Public Interface IBackgroundTransferOperation
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


CostPolicy CostPolicy CostPolicy CostPolicy CostPolicy

Gets and sets the cost policy for the background transfer.

public : BackgroundTransferCostPolicy CostPolicy { get; set; }
BackgroundTransferCostPolicy CostPolicy(); void CostPolicy(BackgroundTransferCostPolicy costpolicy);
public BackgroundTransferCostPolicy CostPolicy { get; set; }
Public ReadWrite Property CostPolicy As BackgroundTransferCostPolicy
var backgroundTransferCostPolicy = iBackgroundTransferOperation.costPolicy;
iBackgroundTransferOperation.costPolicy = backgroundTransferCostPolicy;
BackgroundTransferCostPolicy BackgroundTransferCostPolicy BackgroundTransferCostPolicy

Specifies whether the transfer can happen over costed networks.

Group Group Group Group Group


Group may be altered or unavailable for releases after Windows 8.1. Instead, use the relevant DownloadOperation or UploadOperation TransferGroup.

Gets a string value indicating the group the transfer belongs to.

public : Platform::String Group { get; }
winrt::hstring Group();
public string Group { get; }
Public ReadOnly Property Group As string
var string = iBackgroundTransferOperation.group;
string string string

The group name.

Guid Guid Guid Guid Guid

Gets the Guid for the background transfer operation.

public : Platform::Guid Guid { get; }
Guid Guid();
public Guid Guid { get; }
Public ReadOnly Property Guid As Guid
var guid = iBackgroundTransferOperation.guid;
Guid Guid Guid

The unique ID for the background transfer operation.

Method Method Method Method Method

Specifies the method to use for the background transfer operation.

public : Platform::String Method { get; }
winrt::hstring Method();
public string Method { get; }
Public ReadOnly Property Method As string
var string = iBackgroundTransferOperation.method;
string string string

The method to use. This value can be GET, PUT, RETR, or STOR.

RequestedUri RequestedUri RequestedUri RequestedUri RequestedUri

Gets the URI for the background transfer.

public : Uri RequestedUri { get; }
Uri RequestedUri();
public Uri RequestedUri { get; }
Public ReadOnly Property RequestedUri As Uri
var uri = iBackgroundTransferOperation.requestedUri;
Uri Uri Uri

The URI.


GetResponseInformation() GetResponseInformation() GetResponseInformation() GetResponseInformation() GetResponseInformation()

Gets the response infomation.

public : ResponseInformation GetResponseInformation()
ResponseInformation GetResponseInformation() const;
public ResponseInformation GetResponseInformation()
Public Function GetResponseInformation() As ResponseInformation
var responseInformation = iBackgroundTransferOperation.getResponseInformation();

Contains the data returned by a server response.

GetResultStreamAt(UInt64) GetResultStreamAt(UInt64) GetResultStreamAt(UInt64) GetResultStreamAt(UInt64) GetResultStreamAt(UInt64)

Gets the partial response at the specified position.

public : IInputStream GetResultStreamAt(unsigned __int64 position)
IInputStream GetResultStreamAt(UInt64 position) const;
public IInputStream GetResultStreamAt(UInt64 position)
Public Function GetResultStreamAt(position As UInt64) As IInputStream
var iInputStream = iBackgroundTransferOperation.getResultStreamAt(position);
UInt64 UInt64 UInt64

The position at which to start reading.