toast (トースト XML スキーマ)

  • [アーティクル]

少なくとも 1 つの ビジュアル 要素を含む基本トースト要素。

要素の階層

<トースト>

構文

<toast launch?   = string
      duration? = "long" | "short" 
      displayTimeStamp? = string
      scenario? = "reminder" | "alarm" | "incomingCall" | "urgent" 
      useButtonStyle? = boolean>

  <!-- Child elements -->
  visual,
  audio?,
  commands?
  actions?
  header?
</toast>

キー

? 省略可能 (0 または 1)

属性および要素

属性

属性 説明 データ型 必須 既定値
duration

トーストが表示される時間。

この属性は、次のいずれかの値になります。

  • long
  • short
 いいえ なし
launch

トースト通知によってアプリケーションがアクティブ化されるときにアプリケーションに渡される文字列です。 この文字列の形式とコンテンツは、アプリ独自の使用方法に合わせて、アプリによって定義されます。 ユーザーがトースト通知をタップまたはクリックし、関連するアプリを起動すると、そのアプリは既定の方法で起動されるのではなく、起動文字列によって、そのコンテキストがアプリに渡され、トースト通知のコンテンツに関連するビューがユーザーに表示されます。

 string いいえ なし
displayTimestamp

Creators Update で導入: Windows プラットフォームによって通知が受信された時刻ではなく、通知コンテンツが実際に配信された日時を表すカスタム タイムスタンプで既定のタイムスタンプをオーバーライドします。 この値は、ISO 8601 標準を使用して書式設定された文字列である必要があります。

 string いいえ なし
scenario

トーストが使用されるシナリオ (アラームやアラームなど)。

  • "reminder" - アラーム通知。 既に展開された状態で表示され、無視されるまでユーザーの画面に表示されます。 バックグラウンドでアクティブ化されるトースト ボタン アクションがない限り、これは無視されることに注意してください。
  • "アラーム" - アラーム通知。 既に展開された状態で表示され、無視されるまでユーザーの画面に表示されます。 オーディオは既定でループするようになっていて、アラームのオーディオを使用します。
  • "incomingCall" - 着信呼び出し通知。 既に展開された状態で、特殊な呼び出しの形式で表示され、無視されるまでユーザーの画面に表示されます。 オーディオは既定でループするようになっていて、着信音のオーディオを使用します。
  • "緊急" - 重要な通知。 これにより、ユーザーは、フォーカス アシスト (応答不可) を中断できる優先度の高いトースト通知を送信できるアプリをより細かく制御できます。 これは通知設定で変更できます。

 string いいえ なし
useButtonStyle

スタイル付きボタンを使用するかどうかを指定します。 ボタンのスタイルは、 action 要素の **hint-buttonStyle** 属性によって決まります。

 boolean いいえ false

 

子要素

子要素 説明
audio

トースト通知が表示されたときに再生するサウンドを指定します。 この要素を使用すると、トースト通知オーディオをミュートすることもできます。
commands

各シナリオに関連付けられた適切なコマンドを使用して、着信通話またはアラームを示すためにトースト通知を使用することを指定します。
Visual

トーストを定義する 1 つの バインド 要素が含まれます。
actions

トースト通知に対して最大 5 つの入力と最大 5 つのボタン アクションを宣言するための Container 要素。
ヘッダー

Creators Update で導入されました。 アクション センター内で複数の通知をグループ化するカスタム ヘッダーを指定します。

 

親要素

この最も外側の (ドキュメント) 要素は、他の要素に含められません。

こちらもご覧ください