BackgroundTransferRangesDownloadedEventArgs
BackgroundTransferRangesDownloadedEventArgs
BackgroundTransferRangesDownloadedEventArgs
BackgroundTransferRangesDownloadedEventArgs
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Provides access to information about the incremental download progress event.
public : sealed class BackgroundTransferRangesDownloadedEventArgs : IBackgroundTransferRangesDownloadedEventArgspublic sealed class BackgroundTransferRangesDownloadedEventArgs : IBackgroundTransferRangesDownloadedEventArgsPublic NotInheritable Class BackgroundTransferRangesDownloadedEventArgs Implements IBackgroundTransferRangesDownloadedEventArgs// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Properties
AddedRanges AddedRanges AddedRanges AddedRanges
Prerelease. List of ranges that were downloaded since the previous RangesDownloaded event.
public : IVector<BackgroundTransferFileRange> AddedRanges { get; }public IList<BackgroundTransferFileRange> AddedRanges { get; }Public ReadOnly Property AddedRanges As IList<BackgroundTransferFileRange>// You can use this property in JavaScript.
- Value
- IVector<BackgroundTransferFileRange> IList<BackgroundTransferFileRange> IList<BackgroundTransferFileRange> IList<BackgroundTransferFileRange>
List of ranges that were downloaded since the previous RangesDownloaded event.
WasDownloadRestarted WasDownloadRestarted WasDownloadRestarted WasDownloadRestarted
Prerelease. TRUE if the download was restarted from scratch since the previous RangesDownloaded event.
public : PlatForm::Boolean WasDownloadRestarted { get; }public bool WasDownloadRestarted { get; }Public ReadOnly Property WasDownloadRestarted As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
TRUE if the download was restarted from scratch since the previous RangesDownloaded event, otherwise FALSE.
Remarks
This is important, as the app will need to reset any state related to previously-processed DownloadedRanges data in that case. Download restarts can occur if the remote file’s timestamp or ETag changes.
Methods
GetDeferral() GetDeferral() GetDeferral() GetDeferral()
Prerelease. Deferral allows apps to carry out asynchronous work within their RangesDownloaded handler without receiving a new RangesDownloaded event in the meantime.
public : Deferral GetDeferral()public Deferral GetDeferral()Public Function GetDeferral() As Deferral// You can use this method in JavaScript.
Remarks
Serialized RangesDownloaded events make the app’s code more straightforward and let WinRT BackgroundTransfer coalesce RangesDownloaded events instead of flooding an app with multiple concurrent ones.