トースト通知をオプトインする方法 (Windows ランタイム アプリ)

  • [アーティクル]

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

注  JavaScript を使わない場合は、「トースト通知をオプトインする方法 (XAML)」をご覧ください。

 

ここでは、アプリでトースト通知を表示できることを指定する方法について説明します。

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

テクノロジ

  • Windows Runtime

必要条件

このトピックを理解するための要件:

  • トースト通知に関する用語と概念についての実用的知識。詳しくは、「トーストの概要」をご覧ください。
  • トーストの XML スキーマに関する知識。それに加えて、XML と、ドキュメント オブジェクト モデル (DOM) API を使った XML の操作に関する一般的な知識。詳しくは、「トースト スキーマ」をご覧ください。

手順

ステップ 1: トースト通知機能を宣言する

トースト通知を表示する機能は、アプリの package.appxmanifest ファイルで宣言します。Microsoft Visual Studio マニフェスト エディターを使う場合は、[アプリケーション] タブの [通知] セクションで [トースト対応] オプションを "はい" に設定するだけです。

次の例は、このオプションを選んだことによって package.appxmanifest ファイルに挿入された XML を示しています。マニフェストの VisualElements 要素に、ToastCapable 属性が追加されています。

Visual Studio を使わずに、package.appxmanifest ファイルを手動で作成する場合は、この例に示す内容を追加する必要があります。詳しくは、「パッケージ マニフェストを手動で作成する方法」をご覧ください。Visual Studio のオプションを "はい" に設定すると、package.appxmanifest ファイルに "true" と書き込まれます。


<VisualElements 
    ...
    ToastCapable="true">
</VisualElements>

ステップ 2: トースト通知の背景とテキストの色を宣言する (Windows のみ)

トースト通知の背景色とテキストの色 (薄い色または濃い色) を宣言できます。この設定はタイルにも適用されます。—トースト通知とタイル通知の背景とテキストの色は常にリンクされています。

Visual Studio マニフェスト エディターを使う場合は、[ビジュアル資産] タブの [前景テキスト] オプションを選びます。W3DC の色文字列 ("#FFFFFF" など) を使って [背景色] オプションを設定します。

注  Windows Phone ストア アプリでは、テキストまたは背景の色を設定することはできません。トーストの背景色は、システムのアクセント カラーです。このカラーはユーザーが [設定] で選択することができ、テキストは常に Light です。

次の例は、これらのオプションを選んだことによって package.appxmanifest ファイルに挿入された XML を示しています。マニフェストの VisualElements 要素に、ForegroundText 属性と BackgroundColor 属性が追加されています。


<VisualElements 
    ...
    ForegroundText="dark" 
    BackgroundColor="#FFFFFF">
</VisualElements>

ステップ 3: ロゴ イメージを指定する

トースト通知を表示しているアプリをユーザーに示すために、各トースト通知の右下隅にアプリの小さいロゴ イメージが表示されます。

注  Windows Phone 8.1 ではこのロゴ イメージは使われません。タイルにはアプリの表示名 (マニフェスト内で記述) だけが表示されるか、何も表示されません。

Visual Studio マニフェスト エディターを使う場合は、[ビジュアル資産] タブで [正方形 30 x 30 ロゴ] (Windows) と [正方形 44 x 44 ロゴ] (Windows Phone) のいずれかの画像のパスを設定します。指定した画像は、アプリのパッケージに含まれている必要があります。

次の例は、これらのオプションを選んだことによって package.appxmanifest ファイルに挿入された XML を示しています。マニフェストの VisualElements 要素に、SmallLogo 属性が追加されます。


<VisualElements 
    ...
    SmallLogo="images\smallTile-sdk.png">
</VisualElements>

注釈

上の手順を完了すると、アプリでユーザーにトースト通知を送信できるようになります。

完全な例

次の例は、サンプルの Windows アプリの package.appxmanifest ファイルに含まれる VisualElements 要素の XML 全体を示しています。この XML には、このトピックで説明した属性が含まれています。


<VisualElements 
    DisplayName="ToastsSample" 
    Logo="images\squareTile-sdk.png" 
    SmallLogo="images\smallTile-sdk.png" 
    Description="SDK Sample" 
    ForegroundText="dark" 
    BackgroundColor="#FFFFFF" 
    ToastCapable="true">
    <DefaultTile ShortName="ToastsSample" ShowName="allLogos"/>
    <SplashScreen BackgroundColor="white" Image="images\splash-sdk.png"/>
</VisualElements>

関連トピック

トースト通知の概要

トースト通知のガイドラインとチェック リスト

トースト通知のサンプル