BackgroundTransferRequest Class
July 26, 2012
Represents a background file transfer request.
Namespace:
Microsoft.Phone.BackgroundTransfer
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
The BackgroundTransferRequest type exposes the following members.
| Name | Description | |
|---|---|---|
 | BackgroundTransferRequest(Uri) | Initializes a new instance of the BackgroundTransferRequest class with the specified request URI. |
| BackgroundTransferRequest(Uri, Uri) | Initializes a new instance of the BackgroundTransferRequest class with the specified request URI and download file location. |
| Name | Description | |
|---|---|---|
| BytesReceived | Gets the number of bytes that have been downloaded for the request. |
| BytesSent | Gets the number of bytes that have been uploaded for the request. |
| DownloadLocation | Gets or sets the location to which the requested file will be downloaded. |
| Headers | Gets the dictionary of HTTP headers for the request. |
| Method | Gets or sets the HTTP method for the request. |
| RequestId | Gets the unique identifier associated with the request. |
| RequestUri | Gets the target URI associated with the request. |
| StatusCode | The HTTP status code of the request |
| Tag | Gets or sets additional data associated with the request. |
| TotalBytesToReceive | Gets the total number of bytes that will be downloaded for the request. |
| TotalBytesToSend | Gets the total number of bytes that will be uploaded for the request. |
| TransferError | Gets the exception associated with a failed background transfer request. A transfer request can have a TransferStatus of Completed whether or not the transfer was completed successfully. If a completed transfer was successful, TransferError will be null. |
| TransferPreferences | Gets or sets the preferred conditions under which transfers are enabled. |
| TransferStatus | Gets the status of the request. |
| UploadLocation | Gets or sets the location from which the requested file will be uploaded. |
| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the current instance of the BackgroundTransferRequest class. |
| Equals(Object) | Determines whether this BackgroundTransferRequest is equal to the specified object. (Overrides Object.Equals(Object).) |
| Equals(BackgroundTransferRequest) | Determines whether this BackgroundTransferRequest is equal to the specified object. |
| Finalize | (Inherited from Object.) |
| GetHashCode | Returns the hash code for this instance. (Overrides Object.GetHashCode().) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | Returns a string representation of the BackgroundTransferRequest object. (Overrides Object.ToString().) |
| Name | Description | |
|---|---|---|
| TransferProgressChanged | Occurs when the progress of the transfer changes. |
| TransferStatusChanged | Occurs when the TransferStatus property of a request changes. |
Create a BackgroundTransferRequest object representing a file transfer request and then use the Add method of the BackgroundTransferService class to register the request with the system. Use the Find method to get a BackgroundTransferRequest object representing a transfer request that has already been submitted to obtain status information about the transfer.
For more information on background file transfers, see Background File Transfers Overview for Windows Phone.
