IBackgroundTransferBase
IBackgroundTransferBase
IBackgroundTransferBase
IBackgroundTransferBase
Interface
Definition
Represents a background transfer operation.
public : interface IBackgroundTransferBasepublic interface IBackgroundTransferBasePublic Interface IBackgroundTransferBase// You can use this interface in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Properties
CostPolicy CostPolicy CostPolicy CostPolicy
Gets or sets the cost policy for the background transfer operation.
public : BackgroundTransferCostPolicy CostPolicy { get; set; }public BackgroundTransferCostPolicy CostPolicy { get; set; }Public ReadWrite Property CostPolicy As BackgroundTransferCostPolicy// You can use this property in JavaScript.
- Value
- BackgroundTransferCostPolicy BackgroundTransferCostPolicy BackgroundTransferCostPolicy BackgroundTransferCostPolicy
Specifies whether transfers can occur over costed networks.
Group Group Group Group
Note
Group may be altered or unavailable for releases after Windows 8.1. Instead, use the relevant DownloadOperation or UploadOperation TransferGroup.
Gets are sets a string value indicating the group the transfer will belong to.
public : PlatForm::String Group { get; set; }public string Group { get; set; }Public ReadWrite Property Group As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The group name.
Method Method Method Method
Gets or sets the method to use for the background transfer.
public : PlatForm::String Method { get; set; }public string Method { get; set; }Public ReadWrite Property Method As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The method to use for the download. This value can be GET, PUT, RETR, or STOR.
ProxyCredential ProxyCredential ProxyCredential ProxyCredential
Gets or sets the proxy credentials for the background transfer.
public : PasswordCredential ProxyCredential { get; set; }public PasswordCredential ProxyCredential { get; set; }Public ReadWrite Property ProxyCredential As PasswordCredential// You can use this property in JavaScript.
The proxy credentials for the transfer.
ServerCredential ServerCredential ServerCredential ServerCredential
Gets or sets the credentials used to authenticate with the origin server.
public : PasswordCredential ServerCredential { get; set; }public PasswordCredential ServerCredential { get; set; }Public ReadWrite Property ServerCredential As PasswordCredential// You can use this property in JavaScript.
The credential to use for authentication.
Methods
SetRequestHeader(String, String) SetRequestHeader(String, String) SetRequestHeader(String, String) SetRequestHeader(String, String)
Sets the request headers.
public : void SetRequestHeader(PlatForm::String headerName, PlatForm::String headerValue)public void SetRequestHeader(String headerName, String headerValue)Public Function SetRequestHeader(headerName As String, headerValue As String) As void// You can use this method in JavaScript.
- headerName
- PlatForm::String String String String
The header name.
- headerValue
- PlatForm::String String String String
The header value.
Remarks
This method allows the caller to set request headers. This method can be called multiple times for the same header. The values will then be concatenated.