ServicingComplete トリガーの使用方法 (HTML)

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

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

ここでは、アプリの更新後、ServicingComplete SystemTrigger を使ってバックグラウンドタスク登録を制御する方法について説明します。

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

テクノロジ

Windows.ApplicationModel.Background

必要条件

このトピックは、1 つ以上のバックグラウンドタスクを実行するすべてのアプリに適用されます。バックグラウンドタスククラスの作成に関する詳しい情報については、「クイックスタート: バックグラウンドタスクの作成と登録」をご覧ください。

手順

ステップ 1: ServicingComplete バックグラウンドタスクの作成

バックグラウンドタスク登録は、複数のアプリ更新にわたって継続します。アプリが更新されるとき、アプリの登録は有効なままとなり、トリガーされます。アプリの更新時に通知されるように、ServicingComplete トリガーにバックグラウンドタスクを登録できます。有効でなくなったバックグラウンドタスクは、登録を解除できます。

バックグラウンドタスクのために新しい JavaScript ファイルを作成します。

次のサンプルコードは、バックグラウンドタスクの基本的な開始点を示しています。

//
// ServicingCompleteTask.js
//
(function () {
    "use strict";


    //
    // This function does the work of the ServicingComplete background task.
    //
    function doWork() {


        //
        // A JavaScript background task must call close when it is done.
        //
        close();
    }


    doWork();

})();

登録を解除する必要があるバックグラウンドタスクの登録オブジェクトを見つけます。Unregister を呼び出してタスクの登録を解除します。インスタンスがアクティブな場合には、バックグラウンドタスクの実行を停止する方法として、cancelTask パラメーターを true に設定することもできます。

//
// ServicingCompleteTask.js
//
(function () {
    "use strict";


    //
    // This function does the work of the ServicingComplete background task.
    //
    function doWork() {

        // 
        // Unregister tasks that no longer exist.
        // 

        var unregisterTask = "BadTaskName";

        var unregTask = FindTask(unregisterTask);
        if (unregTask != null) {
            unregTask.Unregister(true);
        }


        //
        // A JavaScript background task must call close when it is done.
        //
        close();
    }


    // 
    // Check for a registration of the named background task. If one exists,
    // return it.
    // 
    function FindTask(taskName) {

        var taskRegistered = false;

        var background = Windows.ApplicationModel.Background;
        var iter = background.BackgroundTaskRegistration.allTasks.first();
        var hascur = iter.hasCurrent;

        while (hascur) {
            var cur = iter.current.value;

            if (cur.name === taskName) {
                return cur;
            }

            hascur = iter.moveNext();
        }
    }


    doWork();

})();

必要に応じ、代替タスクを登録します。「バックグラウンドタスクを登録する方法」で示されているようなバックグラウンドタスクの登録関数を使って、作業を簡略化してください。

//
// ServicingCompleteTask.js
//
(function () {
    "use strict";


    //
    // This function does the work of the ServicingComplete background task.
    //
    function doWork() {

        // 
        // Unregister tasks that no longer exist.
        // 

        var unregisterTask = "BadTaskName";

        var unregTask = FindTask(unregisterTask);
        if (unregTask != null) {
            unregTask.Unregister(true);
        }


        // 
        // Register new/replacement tasks.
        // 

        var newTaskName = "New Background Task";
        var newTaskEntryPoint = "js\\NewBackgroundTask.js";

        var background = Windows.ApplicationModel.Background;
        var internetTrigger = new background.SystemTrigger(
                         background.SystemTriggerType.internetAvailable, false);

        var newTask = RegisterBackgroundTask(newTaskEntryPoint,
                                             newTaskName, 
                                             internetTrigger, 
                                             null);


        //
        // A JavaScript background task must call close when it is done.
        //
        close();
    }


    // 
    // Check for a registration of the named background task. If one exists,
    // return it.
    // 
    function FindTask(taskName) {

        var taskRegistered = false;

        var background = Windows.ApplicationModel.Background;
        var iter = background.BackgroundTaskRegistration.allTasks.first();
        var hascur = iter.hasCurrent;

        while (hascur) {
            var cur = iter.current.value;

            if (cur.name === taskName) {
                return cur;
            }

            hascur = iter.moveNext();
        }
    }


    doWork();

})();

ステップ 2: ServicingComplete バックグラウンドタスクの登録

ServicingComplete バックグラウンドタスクは、他のバックグラウンドタスクと一緒に登録する必要があります。これは、アプリが更新される時点でトリガーされるようにするためです。ServicingComplete バックグラウンドタスクのエントリポイントは、アプリの更新プログラムでも同じでなければなりません。

新しい SystemTrigger オブジェクトを作ります。
- 最初のパラメーター triggerType は servicingComplete に設定する必要があります。
- 2 つ目のパラメーター OneShot は false に設定する必要があります。
このコード例では、ServicingComplete トリガーを作っています。
```
var background = Windows.ApplicationModel.Background;

var servicingCompleteTrigger = new background.SystemTrigger(
                        background.SystemTriggerType.servicingComplete, false);
```
注 ServicingComplete バックグラウンドタスクトリガーに条件を追加することはお勧めできません。
バックグラウンドタスク登録関数を呼び出し、タスクを登録します。バックグラウンドタスクの登録について詳しくは、「バックグラウンドタスクを登録する方法」をご覧ください。

次のコードでは、ServicingComplete タスクを登録しています。
```
var entryPoint = "js\\ServicingCompleteTask.js";
var taskName = "ServicingComplete background task";

var task = RegisterBackgroundTask(entryPoint,
                                  taskName, 
                                  servicingCompleteTrigger, 
                                  null);
```
注 Windows Phone ストアアプリでは、バックグラウンドタスクを登録する前に RequestAccessAsync を 1 回呼び出す必要があります。

ステップ 3: パッケージマニフェストでバックグラウンドタスクを宣言します。

他のバックグラウンドタスクと同様に、ServicingComplete バックグラウンドタスクはパッケージマニフェストに表示される必要があります。詳しくは、「アプリケーションマニフェストでバックグラウンドタスクを宣言する方法」をご覧ください。以下に例を示します。

アプリマニフェストで宣言された ServicingCompleteTask

注釈

バックグラウンドタスクによるアプリ更新のデバッグに関連する重要な情報については、「バックグラウンドタスクをデバッグする方法 (Windows ストアアプリ)」をご覧ください。

次の方法で共有

ServicingComplete トリガーの使用方法 (HTML)

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

テクノロジ

必要条件

手順

ステップ 1: ServicingComplete バックグラウンドタスクの作成

ステップ 2: ServicingComplete バックグラウンドタスクの登録

ステップ 3: パッケージマニフェストでバックグラウンドタスクを宣言します。

注釈

関連トピック

その他のリソース

次の方法で共有

ServicingComplete トリガーの使用方法 (HTML)

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

テクノロジ

必要条件

手順

ステップ 1: ServicingComplete バックグラウンド タスクの作成

ステップ 2: ServicingComplete バックグラウンド タスクの登録

ステップ 3: パッケージ マニフェストでバックグラウンド タスクを宣言します。

注釈

関連トピック

その他のリソース

ステップ 1: ServicingComplete バックグラウンドタスクの作成

ステップ 2: ServicingComplete バックグラウンドタスクの登録

ステップ 3: パッケージマニフェストでバックグラウンドタスクを宣言します。