アプリケーションマニフェストでのバックグラウンドタスクの宣言

[アーティクル]
06/02/2023

重要な API

アプリマニフェストでバックグラウンドタスクを拡張機能として宣言し、バックグラウンドタスクを使うことができるようにします。

重要

この記事は、アウトプロセスのバックグラウンドタスクに固有です。インプロセスのバックグラウンドタスクは、マニフェストで宣言されていません。

アウトプロセスのバックグラウンドタスクはアプリマニフェストで宣言されている必要があります。このようにしないと、アプリはバックグラウンドタスクを登録できません (例外がスローされます)。また、認定に合格するには、アプリケーションマニフェストでアウトプロセスのバックグラウンドタスクを宣言する必要があります。

このトピックでは、1 つ以上のバックグラウンドタスククラスが作られていて、少なくとも 1 つのトリガーに応答して実行されるようにアプリで各バックグラウンドタスクを登録するものとします。

手動での拡張機能の追加

アプリケーションマニフェスト (Package.appxmanifest) を開き、Application 要素に移動します。 Extensions 要素を作ります (まだ存在していない場合)。

次に示す例は、バックグラウンドタスクのサンプルから抜粋したものです。

<Application Id="App"
   ...
   <Extensions>
     <Extension Category="windows.backgroundTasks" EntryPoint="Tasks.SampleBackgroundTask">
       <BackgroundTasks>
         <Task Type="systemEvent" />
         <Task Type="timer" />
       </BackgroundTasks>
     </Extension>
     <Extension Category="windows.backgroundTasks" EntryPoint="Tasks.ServicingComplete">
       <BackgroundTasks>
         <Task Type="systemEvent"/>
       </BackgroundTasks>
     </Extension>
   </Extensions>
 </Application>

バックグラウンドタスク拡張機能の追加

最初のバックグラウンドタスクを宣言します。

このコードを Extensions 要素にコピーします (次の手順で属性を追加します)。

<Extensions>
    <Extension Category="windows.backgroundTasks" EntryPoint="">
      <BackgroundTasks>
        <Task Type="" />
      </BackgroundTasks>
    </Extension>
</Extensions>

EntryPoint 属性を、バックグラウンドタスクの登録時にエントリポイントとしてコードで使ったものと同じ文字列に変更します (namespace.classname)。

この例のエントリポイントは、ExampleBackgroundTaskNameSpace.ExampleBackgroundTaskClassName です。

<Extensions>
    <Extension Category="windows.backgroundTasks" EntryPoint="Tasks.ExampleBackgroundTaskClassName">
       <BackgroundTasks>
         <Task Type="" />
       </BackgroundTasks>
    </Extension>
</Extensions>

Task Type 属性のリストを、このバックグラウンドタスクで使われるタスク登録の種類を示すように変更します。バックグラウンドタスクを複数の種類のトリガーで登録する場合は、必要な Task 要素と Type 属性を個々に追加します。

注使っているトリガーの各種類を確実に列記してください。そうしないと、バックグラウンドタスクは宣言されていない種類のトリガーには登録されません (Register メソッドが失敗し、例外がスローされます)。

次の抜粋例は、システムイベントトリガーとプッシュ通知の使用法を示します。

<Extension Category="windows.backgroundTasks" EntryPoint="Tasks.BackgroundTaskClass">
    <BackgroundTasks>
        <Task Type="systemEvent" />
        <Task Type="pushNotification" />
    </BackgroundTasks>
</Extension>

複数のバックグラウンドタスク拡張機能の追加

アプリで登録する追加のバックグラウンドタスククラスごとに、手順 2. を繰り返します。

次に、バックグラウンドタスクサンプルの完全な Application 要素の例を示します。これは、計 3 種類のトリガーで 2 つのバックグラウンドタスククラスを使う例を示します。この例の Extensions セクションをコピーし、必要に応じて変更して、アプリケーションマニフェストでバックグラウンドタスクを宣言します。

<Applications>
    <Application Id="App"
      Executable="$targetnametoken$.exe"
      EntryPoint="BackgroundTask.App">
        <uap:VisualElements
          DisplayName="BackgroundTask"
          Square150x150Logo="Assets\StoreLogo-sdk.png"
          Square44x44Logo="Assets\SmallTile-sdk.png"
          Description="BackgroundTask"

          BackgroundColor="#00b2f0">
          <uap:LockScreen Notification="badgeAndTileText" BadgeLogo="Assets\smalltile-Windows-sdk.png" />
            <uap:SplashScreen Image="Assets\Splash-sdk.png" />
            <uap:DefaultTile DefaultSize="square150x150Logo" Wide310x150Logo="Assets\tile-sdk.png" >
                <uap:ShowNameOnTiles>
                    <uap:ShowOn Tile="square150x150Logo" />
                    <uap:ShowOn Tile="wide310x150Logo" />
                </uap:ShowNameOnTiles>
            </uap:DefaultTile>
        </uap:VisualElements>

      <Extensions>
        <Extension Category="windows.backgroundTasks" EntryPoint="Tasks.SampleBackgroundTask">
          <BackgroundTasks>
            <Task Type="systemEvent" />
            <Task Type="timer" />
          </BackgroundTasks>
        </Extension>
        <Extension Category="windows.backgroundTasks" EntryPoint="Tasks.ServicingComplete">
          <BackgroundTasks>
            <Task Type="systemEvent"/>
          </BackgroundTasks>
        </Extension>
      </Extensions>
    </Application>
</Applications>

バックグラウンドタスクの実行先の宣言

バックグラウンドタスクの実行先を指定することができます。

既定では、BackgroundTaskHost.exe プロセスで実行されます。
フォアグラウンドアプリケーションと同じプロセスで実行できます。
ResourceGroup を使用すると、複数のバックグラウンドタスクを同じホスティングプロセスに配置したり、異なるプロセスに分離したりすることができます。
SupportsMultipleInstances を使用すると、新しいトリガーが発生するたびに、独自のリソース制限 (メモリ、CPU) を持つ新しいプロセスでバックグラウンドプロセスが実行されます。

フォアグラウンドアプリケーションと同じプロセスでの実行

フォアグラウンドアプリケーションと同じプロセスで実行されるバックグラウンドタスクを宣言する XML の例を次に示します。

<Extensions>
    <Extension Category="windows.backgroundTasks" EntryPoint="ExecModelTestBackgroundTasks.ApplicationTriggerTask">
        <BackgroundTasks>
            <Task Type="systemEvent" />
        </BackgroundTasks>
    </Extension>
</Extensions>

EntryPoint を指定すると、アプリケーションは指定されたメソッドへのコールバックをトリガーの発生時に受け取ります。 EntryPoint を指定していない場合、アプリケーションは OnBackgroundActivated() を介してコールバックを受け取ります。詳しくは、「インプロセスバックグラウンドタスクの作成と登録」をご覧ください

ResourceGroup 属性を使用して、バックグラウンドタスクの実行先を指定

BackgroundTaskHost.exe プロセスで実行されるが、同じアプリのバックグラウンドタスクの他のインスタンスとは別に実行される、バックグラウンドタスクを宣言する XML の例を示します。共に実行されるバックグラウンドタスクを指定する、ResourceGroup 属性に注意してください。

<Extensions>
    <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.SessionConnectedTriggerTask" ResourceGroup="foo">
      <BackgroundTasks>
        <Task Type="systemEvent" />
      </BackgroundTasks>
    </Extension>
    <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.TimeZoneTriggerTask" ResourceGroup="foo">
      <BackgroundTasks>
        <Task Type="systemEvent" />
      </BackgroundTasks>
    </Extension>
    <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.TimerTriggerTask" ResourceGroup="bar">
      <BackgroundTasks>
        <Task Type="timer" />
      </BackgroundTasks>
    </Extension>
    <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.ApplicationTriggerTask" ResourceGroup="bar">
      <BackgroundTasks>
        <Task Type="general" />
      </BackgroundTasks>
    </Extension>
    <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.MaintenanceTriggerTask" ResourceGroup="foobar">
      <BackgroundTasks>
        <Task Type="general" />
      </BackgroundTasks>
    </Extension>
</Extensions>

SupportsMultipleInstances 属性を使用して、トリガーが発生するたびに新しいプロセスで実行

この例では、新しいトリガーが発生するたびに独自のリソース制限 (メモリと CPU) を持つ新しいプロセスで実行される、バックグラウンドタスクを宣言します。 SupportsMultipleInstances を使っていることに注目してください。この属性がこの動作を実現します。この属性を使用するには、SDK バージョン '10.0.15063' (Windows 10 Creators Update) 以降をターゲットにする必要があります。

<Package
    xmlns:uap4="http://schemas.microsoft.com/appx/manifest/uap/windows10/4"
    ...
    <Applications>
        <Application ...>
            ...
            <Extensions>
                <Extension Category="windows.backgroundTasks" EntryPoint="BackgroundTasks.TimerTriggerTask">
                    <BackgroundTasks uap4:SupportsMultipleInstances="true">
                        <Task Type="timer" />
                    </BackgroundTasks>
                </Extension>
            </Extensions>
        </Application>
    </Applications>

注意

SupportsMultipleInstances と共に ResourceGroup または ServerName を指定することはできません。

アプリケーションマニフェストでのバックグラウンドタスクの宣言

手動での拡張機能の追加

バックグラウンドタスク拡張機能の追加

複数のバックグラウンドタスク拡張機能の追加

バックグラウンドタスクの実行先の宣言

フォアグラウンドアプリケーションと同じプロセスでの実行

ResourceGroup 属性を使用して、バックグラウンドタスクの実行先を指定

SupportsMultipleInstances 属性を使用して、トリガーが発生するたびに新しいプロセスで実行

フィードバック

フィードバック

その他のリソース

アプリケーション マニフェストでのバックグラウンド タスクの宣言

手動での拡張機能の追加

バックグラウンド タスク拡張機能の追加

複数のバックグラウンド タスク拡張機能の追加

バック グラウンド タスクの実行先の宣言

フォアグラウンド アプリケーションと同じプロセスでの実行

ResourceGroup 属性を使用して、バックグラウンド タスクの実行先を指定

SupportsMultipleInstances 属性を使用して、トリガーが発生するたびに新しいプロセスで実行

関連トピック

フィードバック

フィードバック

その他のリソース

アプリケーションマニフェストでのバックグラウンドタスクの宣言

バックグラウンドタスク拡張機能の追加

複数のバックグラウンドタスク拡張機能の追加

バックグラウンドタスクの実行先の宣言

フォアグラウンドアプリケーションと同じプロセスでの実行

ResourceGroup 属性を使用して、バックグラウンドタスクの実行先を指定