BackgroundTransferCompletionGroup クラス

リファレンス

定義

名前空間:: Windows.Networking.BackgroundTransfer

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

すべての操作が完了した後 (操作が正常に完了した場合) またはエラーで失敗した後にバックグラウンドタスクをトリガーする一連のバックグラウンド転送操作 (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 を実装する必要があります。 IBackgroundTask は BackgroundTaskBuilder クラスを使用して登録する必要があります。 BackgroundTransferCompletionGroup.Trigger を使用してタスクを設定すると、ブローカーインフラストラクチャはトリガーされるとすぐに自動的に登録解除されるため、明示的なタスク登録解除コードは必要ありません。

バックグラウンドタスクは、アプリマニフェストで宣言する必要があります。アプリでは、BackgroundTransferCompletionGroup を使用するためにロック画面へのアクセスは必要ありません。

コンストラクター

BackgroundTransferCompletionGroup()

新しい BackgroundTransferCompletionGroup オブジェクトを作成します。

プロパティ

IsEnabled	BackgroundTransferCompletionGroup の Enable メソッドが既に呼び出されているかどうかを示す値を取得します。
Trigger	BackgroundTransferCompletionGroup に関連付けられたバックグラウンドタスクの設定に使用される IBackgroundTrigger を取得します。

メソッド

Enable()

BackgroundTransferCompletionGroup が完了し、バックグラウンド転送操作 (DownloadOperation オブジェクトまたは UploadOperation オブジェクト) が完了グループに追加されなくなることを示します。

適用対象