バックグラウンドタスクの進行状況と完了を監視する方法 (HTML)

[アーティクル]
12/22/2015

[ この記事は、Windows ランタイムアプリを作成する Windows 8.x および Windows Phone 8.x 開発者を対象としています。Windows 10 向けの開発を行っている場合は、「最新のドキュメント」をご覧ください]

バックグラウンドタスクから報告される進行状況と完了をアプリから認識する方法について説明します。バックグラウンドタスクは、アプリから切り離され、個別に実行されますが、バックグラウンドタスクの進行と完了の状況をアプリコードによって監視することができます。これを行うために、アプリでは、システムに登録されたバックグラウンドタスクのイベントを受信登録します。

理解しておく必要があること

テクノロジ

Windows.ApplicationModel.Background

必要条件

このトピックでは、アプリで既にバックグラウンドタスクが登録されていることを前提とします。バックグラウンドタスクを直ちに構築する場合は、「クイックスタート: バックグラウンドタスクの作成と登録」をご覧ください。条件とトリガーについて詳しくは、「バックグラウンドタスクによるアプリのサポート」をご覧ください。

手順

ステップ 1:

バックグラウンドタスク完了のイベントハンドラーにアタッチされる関数を作ります。この関数には BackgroundTaskCompletedEventArgs オブジェクトを指定し、他のパラメーターは指定しないようにする必要があります。

関数をローカルに登録する場合は、次のフットプリントを使うことができます。
```
function OnCompleted(args)
{
    // TODO: Add code that deals with background task completion.
}
```
そして、次のように BackgroundTaskRegistration オブジェクト (成功した Register 関数呼び出しによって取得) を使って関数を登録できます。
```
backgroundTaskRegistration.addEventListener("completed", onCompleted);
```
バックグラウンドタスクの完了を処理するコードを追加する必要があります。

たとえば、バックグラウンドタスクのサンプルでは、LocalSettings に保存された完了状態により、UI が更新されます。
```
function OnCompleted(args)
{
    // 
    // 
    // 
    backgroundTaskName = this.name;

    // 
    // Call a method to update the UI (beyond the scope of this example).
    // 
    UpdateUI();
}
```

堅牢なアプリでは、CheckResult を呼び出すことにより、バックグラウンドタスクからスローされた例外をチェックできます。

バックグラウンドタスクのサンプルメソッドを次のように変更することで、バックグラウンドタスクからスローされた例外を処理できます。

function OnCompleted(task, args)
{
    var settings = ApplicationData.Current.LocalSettings;
    var key = task.TaskId.ToString();

    try
    {
        args.CheckResult();
        BackgroundTaskSample.SampleBackgroundTaskStatus = settings.Values[key].ToString();
    }
    catch (Exception ex)
    {
        BackgroundTaskSample.SampleBackgroundTaskStatus = "Error: " + ex.Message;
    }

    UpdateUI();
}

ステップ 2:

完了したバックグラウンドタスクを処理するイベントハンドラー関数を作ります。このコードは、IBackgroundTaskRegistration オブジェクトと BackgroundTaskProgressEventArgs オブジェクトを受け入れる特定のフットプリントに従っている必要があります。

OnProgress バックグラウンドタスクイベントハンドラーメソッドには次のフットプリントを使います。
```
function OnProgress(task, args)
{
    // TODO: Add code that deals with background task progress.
}
```
バックグラウンドタスクの完了を処理するイベントハンドラーにコードを追加します。

たとえば、バックグラウンドタスクのサンプルでは、args パラメーターで渡された進行状態により、UI が更新されます。
```
function OnProgress(task, args)
{
    var progress = "Progress: " + args.Progress + "%";
    BackgroundTaskSample.SampleBackgroundTaskProgress = progress;
    UpdateUI();
}
```

ステップ 3:

新規のバックグラウンドタスクと既存のバックグラウンドタスクと共に、イベントハンドラー関数を登録します。

アプリで初めてバックグラウンドタスクを登録するときは、フォアグラウンドでまだアプリがアクティブになっていてタスクか実行されている場合に、進行状況と完了の更新を受け取ることができるように登録する必要があります。

たとえば、バックグラウンドタスクのサンプルでは、登録するバックグラウンドタスクごとに次の関数を呼び出します。
```
function AttachProgressAndCompletedHandlers(IBackgroundTaskRegistration task)
{
    task.Progress += new BackgroundTaskProgressEventHandler(OnProgress);
    task.Completed += new BackgroundTaskCompletedEventHandler(OnCompleted);
}
```
アプリが起動された時点、またはバックグラウンドタスクの状態が関連する新しいページに移動した時点で、現在登録されているバックグラウンドタスクの一覧を取得し、進行状況と完了に対応するイベントハンドラー関数に関連付ける必要があります。アプリケーションで現在登録されているバックグラウンドタスクの一覧は、BackgroundTaskRegistration.AllTasks プロパティで保持されます。

たとえば、バックグラウンドタスクのサンプルでは、次のコードを使って SampleBackgroundTask ページの移動時にイベントハンドラーをアタッチします。
```
function OnNavigatedTo(NavigationEventArgs e)
{
    foreach (var task in BackgroundTaskRegistration.AllTasks)
    {
        if (task.Value.Name == BackgroundTaskSample.SampleBackgroundTaskName)
        {
            AttachProgressAndCompletedHandlers(task.Value);
            BackgroundTaskSample.UpdateBackgroundTaskStatus(BackgroundTaskSample.SampleBackgroundTaskName, true);
        }
    }

    UpdateUI();
}
```

次の方法で共有

バックグラウンドタスクの進行状況と完了を監視する方法 (HTML)

理解しておく必要があること

テクノロジ

必要条件

手順

ステップ 1:

ステップ 2:

ステップ 3:

関連トピック

その他のリソース

次の方法で共有

バックグラウンド タスクの進行状況と完了を監視する方法 (HTML)

理解しておく必要があること

テクノロジ

必要条件

手順

ステップ 1:

ステップ 2:

ステップ 3:

関連トピック

その他のリソース

バックグラウンドタスクの進行状況と完了を監視する方法 (HTML)