IBackgroundTransferBase IBackgroundTransferBase IBackgroundTransferBase IBackgroundTransferBase Interface

Represents a background transfer operation.

Syntax

Declaration

public interface IBackgroundTransferBasepublic interface IBackgroundTransferBasePublic Interface IBackgroundTransferBase

Properties summary

Gets or sets the cost policy for the background transfer operation.

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.

Gets or sets the method to use for the background transfer.

Gets or sets the proxy credentials for the background transfer.

Gets or sets the credentials used to authenticate with the origin server.

Methods summary

Sets the request headers.

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

    Property Value

  • 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 string Group { get; set; }public string Group { get; set; }Public ReadWrite Property Group As string

    Property Value

    • string
      string
      string
      string

      The group name.

  • Method
    Method
    Method
    Method

    Gets or sets the method to use for the background transfer.

    public string Method { get; set; }public string Method { get; set; }Public ReadWrite Property Method As string

    Property Value

    • 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

    Property Value

  • 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

    Property Value

Methods

  • SetRequestHeader(System.String,System.String)
    SetRequestHeader(System.String,System.String)
    SetRequestHeader(System.String,System.String)
    SetRequestHeader(System.String,System.String)

    Sets the request headers.

    public void SetRequestHeader(System.String headerName,System.String headerValue)public void SetRequestHeader(System.String headerName,System.String headerValue)Public Function SetRequestHeader(headerName As System.String,headerValue As System.String) As void

    Parameters

    • headerName
      System.String
      System.String
      System.String
      System.String

      The header name.

    • headerValue
      System.String
      System.String
      System.String
      System.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.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.Networking.BackgroundTransfer.dll