TransferStatus Enumeration
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Defines the list of states that a background transfer request can be.
Namespace: Microsoft.Phone.BackgroundTransfer
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
Syntax
Public Enumeration TransferStatus
public enum TransferStatus
<object property="enumerationValue" .../>
Members
| Member name | Description | |
|---|---|---|
| None | The request has not yet been queued. | |
| Transferring | The requested file is currently being transferred. | |
| Waiting | The request is waiting in the background transfer service queue. This status can indicate that the request is queued and waiting for previous transfers to complete or that the service is retrying the request due to a network error. | |
| WaitingForWiFi | The request is waiting in the background transfer service queue for a Wi-Fi connection. | |
| WaitingForExternalPower | The request is waiting in the background transfer service queue for external power to be connected. | |
| WaitingForExternalPowerDueToBatterySaverMode | The request is waiting for the device to be connected to external power because the user has enabled Battery Saver mode on the device. | |
| WaitingForNonVoiceBlockingNetwork | The background transfer service does not run when the device is on a non-simultaneous voice and data network, including 2G, EDGE, and standard GPRS. This status indicates the service is waiting for a supported network connection. | |
| Paused | The request has been paused and waiting in the background transfer service queue. | |
| Completed | The request has completed. This means that the request is no longer actionable by the background transfer service regardless of whether the transfer was completed successfully. To confirm that a transfer was successful, confirm that the TransferError property is null. | |
| Unknown | The background transfer service could not retrieve the request status from the service. Once in this state, a BackgroundTransferRequest object is no longer useable. You may attempt to retrieve a new instance using the Find(String) method. |
Remarks
Access transfer status information using the TransferStatus property of the BackgroundTransferRequest class. To receive updates when the status of a transfer request changes, implement a handler for the TransferStatusChanged event.
Capabilities
If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.
ID_CAP_NETWORKING |
Windows Phone 8, Windows Phone OS 7.1 |
For more info, see App capabilities and hardware requirements for Windows Phone 8.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1
Platforms
Windows Phone