Windows Phone 8.1 でバックグラウンドタスクを作る

やっぱり Windows Phone アプリならライブタイルを使わないとね。

という事で自動的にタイルを更新すべく以下を参考にしてバックグラウンドタスクを作っていきます。

クイックスタート: バックグラウンドタスクの作成と登録 (XAML) (Windows)

バックグラウンドタスク用のクラスを作る

新しいプロジェクトを追加してバックグラウンドタスク用のクラスを作ります。
Phone 7 の頃は「スケジュールされたタスクエージェント」みたいなプロジェクトテンプレートがあったのですが、ユニバーサルアプリの場合は~~普通の (PCL) クラスライブラリのプロジェクトを選択します。~~ Windows ランタイムコンポーネントを選択します。

f:id:kazuakix:20141005160237j:plain,w500
　
新しいプロジェクトには IBackgroundTask インターフェイスを実装したクラスを追加します。また、IBackgroundTask に必要な Run メソッドも実装しておきます。

Run メソッドの中身は taskInstance.GetDeferral() で遅延を要求して、何らかの処理をした後 deferral.Complete() で完了を通知するような形になります。

namespace BackgroundTasks
{
    public sealed class TileUpdateTask : IBackgroundTask
    {
        public async void Run(IBackgroundTaskInstance taskInstance)
        {
            // 遅延を要求
            var deferral = taskInstance.GetDeferral();
            // なんやかんや の処理
            deferral.Complete(); // 遅延の完了
        }
    }
}

バックグラウンドタスクを登録する

作成したバックグラウンドタスクはタスク名とエントリポイント、更新間隔を指定して登録します。
タスク名はタスクを識別するための適当な名前、エントリポイントはタスクが実行するためのクラス名 ("名前空間.クラス名" の形式で) になります。

また、既にタスクが登録済みの場合は事前に削除してやる必要があります。

public async void RegisterBackgroundTask(string taskName, string taskEntryPoint)
{
    // タスク登録前に必要
    await BackgroundExecutionManager.RequestAccessAsync();

    // 既存のタスクを削除
    foreach (var task in BackgroundTaskRegistration.AllTasks)
    {
        if (task.Value.Name == taskName)
        {
            task.Value.Unregister(true);
        }
    }

    // 新しいタスクを登録
    var taskBuilder            = new BackgroundTaskBuilder();
    taskBuilder.Name           = taskName;              // タスクの識別名
    taskBuilder.TaskEntryPoint = taskEntryPoint;        // タスクのエントリポイント
    taskBuilder.SetTrigger(new TimeTrigger(15, false));  // 15 分間隔
    var registration           = taskBuilder.Register();
}