BackgroundTransferCompletionGroup 类

  • 参考

定义

命名空间:
Windows.Networking.BackgroundTransfer
编辑

表示一组后台传输操作， (DownloadOperation 或 UploadOperation 对象) ，在完成所有操作后触发后台任务 (如果操作成功完成) 或失败并出现错误。

public ref class BackgroundTransferCompletionGroup sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundTransferCompletionGroup final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class BackgroundTransferCompletionGroup final
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTransferCompletionGroup
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class BackgroundTransferCompletionGroup
function BackgroundTransferCompletionGroup()
Public NotInheritable Class BackgroundTransferCompletionGroup
继承
Object Platform::Object IInspectable BackgroundTransferCompletionGroup
属性
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列
Windows 10 (在 10.0.10240.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

注解

BackgroundTransferCompletionGroup 类允许应用注册，以便在后台传输操作完成后立即收到通知，即使应用不在前台也是如此。 应用会注册后台任务，以接收在后台传输成功完成或发生错误时发生的通知。 这样，应用就可以在完成时立即收到通知，而不是要求应用等到应用下次重启或移动到前台以查询完成情况。

应用必须实现 IBackgroundTask 才能运行接收完成通知。 必须使用 BackgroundTaskBuilder 类注册 IBackgroundTask。 使用 BackgroundTransferCompletionGroup.Trigger 设置任务时，Broker 基础结构会在触发任务后立即自动取消注册，因此无需有任何显式任务取消注册代码。

必须在应用清单中声明后台任务。 应用不需要锁屏访问即可使用 BackgroundTransferCompletionGroup。

构造函数

BackgroundTransferCompletionGroup()

创建新的 BackgroundTransferCompletionGroup 对象。

属性

IsEnabled

获取一个值，该值指示是否已调用 BackgroundTransferCompletionGroup 上的 Enable 方法。
Trigger

获取用于设置与 BackgroundTransferCompletionGroup 关联的后台任务的 IBackgroundTrigger。

方法

Enable()

指示 BackgroundTransferCompletionGroup 已完成，并且不会再 (DownloadOperation 或 UploadOperation 对象) 完成组添加后台传输操作。

适用于

另请参阅