トースト コンテンツ スキーマ
ここでは、トースト コンテンツ内にあるすべてのプロパティと要素について説明します。
Notifications ライブラリではなく生の XML を使う場合は、「XML スキーマ」をご覧ください。
トースト コンテンツ
ToastContentは、視覚効果、 動作 、オーディオなどのタイル通知のコンテンツを説明する最上位のオブジェクトです。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
Launch | string | false | トーストによってアクティブ化されたときにアプリケーションに渡される文字列。 この文字列の形式と内容は、アプリによって独自に定義されます。 ユーザーがトーストをタップまたはクリックして関連付けられたアプリを起動すると、起動文字列は、既定の方法で起動するのではなく、トースト コンテンツに関連するビューをユーザーに表示できるようにするコンテキストをアプリに提供します。 |
Visual | ToastVisual | true | トースト通知の視覚的な部分について説明します。 |
アクション | IToastActions | false | 必要に応じて、ボタンと入力を使用してカスタム アクションを作成します。 |
オーディオ | トーストオーディオ | false | トースト通知の音声部分について説明します。 |
ActivationType | ToastActivationType | false | ユーザーがこのトーストの本文をクリックしたときに使用するアクティブ化の種類を指定します。 |
ActivationOptions | ToastActivationOptions | false | Creators Update の新機能: トースト通知のアクティブ化に関連する追加オプション。 |
シナリオ | トーストシナリオ | false | アラームやリマインダなど、トーストが使用されるシナリオを宣言します。 |
DisplayTimestamp | DateTimeOffset? | false | Creators Update の新機能: カスタム タイムスタンプで既定のタイムスタンプをオーバーライドすることが、Windows プラットフォームが通知を受信した時刻ではなく、通知コンテンツが実際に配信された日時を表す。 |
ヘッダー | トーストヘッダー | false | Creators Update の新機能: アクション センター内で複数の通知をグループ化するためのカスタム ヘッダーを通知に追加します。 |
トーストシナリオ
トーストが表すシナリオを指定します。
Value | 意味 |
---|---|
既定値 | 通常のトースト動作。 |
リマインダー | リマインダ通知 これは事前に展開されて表示され、閉じるまでユーザーの画面に残ります。 |
アラーム | アラーム通知。 これは事前に展開されて表示され、閉じるまでユーザーの画面に残ります。 オーディオは既定でループし、アラーム オーディオを使用します。 |
IncomingCall | 着信通知。 特別な通話形式で事前に展開されて表示され、閉じるまでユーザーの画面にとどまります。 オーディオは既定でループし、着信音オーディオを使用します。 |
ToastVisual
トーストの視覚的な部分には、テキスト、画像、アダプティブ コンテンツなどを含むバインディングが含まれています。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
BindingGeneric | ToastBindingGeneric | true | 汎用トーストバインディングはすべてのデバイスで表示できます。 このバインディングは必須であり、null にすることはできません。 |
BaseUri | Uri | false | 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。 |
AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100ms-contrast=standardms-lang=en-us" に変わります。 |
Language | string | false | ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。 このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。 未指定の場合は、システム ロケールが代わりに使用されます。 |
ToastBindingGeneric
汎用バインディングはトーストの既定のバインディングであり、テキスト、画像、アダプティブ コンテンツなどを指定する場所です。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
Children | IList<IToastBindingGenericChild> | false | トーストの本文の内容はテキスト、画像、グループ (Anniversary Update で追加) を含めることができます。 テキスト要素は、他の要素の前に存在する必要があり、サポートされているテキスト要素は 3 つだけです。 テキスト要素が他の要素の後に配置された場合は、先頭にプルされるか、ドロップされます。 最後に、HintStyle などの特定のテキスト プロパティは、ルートの子テキスト要素ではサポートされておらず、AdaptiveSubgroup 内でのみ機能します。 Anniversary Update がないデバイスで AdaptiveGroup を使用すると、グループのコンテンツは単に削除されます。 |
AppLogoOverride | ToastGenericAppLogo | false | アプリのロゴをオーバーライドするオプションのロゴ。 |
HeroImage | ToastGenericHeroImage | false | アクション センター内のトーストに、特色の "ヒーロー" 画像が表示される。 |
Attribution | ToastGenericAttributionText | false | 属性テキストがトースト通知の下部に表示されます。 |
BaseUri | Uri | false | 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。 |
AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100ms-contrast=standardms-lang=en-us" に変わります。 |
Language | string | false | ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。 このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。 未指定の場合は、システム ロケールが代わりに使用されます。 |
IToastBindingGenericChild
テキスト、画像、グループなどを含むトースト子要素のマーカー インターフェイス。
実装 |
---|
AdaptiveText |
AdaptiveImage |
AdaptiveGroup |
AdaptiveProgressBar |
AdaptiveText
アダプティブなテキスト要素です。 最上位レベルの ToastBindingGeneric.Children に配置された場合は、HintMaxLines のみが適用されます。 ただし、これがグループ/サブグループの子として配置されている場合は、フルテキスト スタイルがサポートされます。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
テキスト | string または BindableString | false | 表示するテキスト。 Creators Update でデータ バインディングのサポートが追加されましたが、最上位のテキスト要素に対してのみ機能します。 |
HintStyle | AdaptiveTextStyle | false | このスタイルは、テキストのフォント サイズ、太さ、および不透明度を制御します。 グループ/サブグループ内のテキスト要素に対してのみ機能します。 |
HintWrap | bool? | false | true に設定すると、テキストの折り返しが有効になります。 最上位のテキスト要素は、このプロパティを無視し、常に折り返します (HintMaxLines = 1 を使用して、最上位のテキスト要素の折り返しを無効にすることができます)。 グループ/サブグループ内のテキスト要素は、折り返しの既定値は false です。 |
HintMaxLines | int? | false | 表示が許可される、テキスト要素の最大行数です。 |
HintMinLines | int? | false | 表示する必要のある、テキスト要素の最小行数です。 グループ/サブグループ内のテキスト要素に対してのみ機能します。 |
HintAlign | AdaptiveTextAlign | false | テキストの水平方向の配置。 グループ/サブグループ内のテキスト要素に対してのみ機能します。 |
Language | string | false | XML ペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。 ここで指定されたロケールは、バインディングか視覚的な要素で指定されたその他のあらゆるロケールを上書きします。 この値がリテラル文字列の場合、この属性の既定値はユーザーの UI 言語になります。 この値が文字列リファレンスの場合、この属性の既定値は、文字列を解決する際に Windows ランタイムで選択されたロケールになります。 |
BindableString
文字列のバインド値。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
BindingName | string | true | バインディング データ値にマップされる名前を取得または設定します。 |
AdaptiveTextStyle
テキスト スタイルは、フォント サイズ、太さ、および不透明度を制御します。 "Subtle" の不透明度は 60% の不透明度になります。
値 | 意味 |
---|---|
既定 | 既定値です。 スタイルがレンダラーによって決定されます。 |
Caption | 段落のフォント サイズより小さいサイズです。 |
CaptionSubtle | Caption と同じですが、不透明度が Subtle です。 |
本文 | 段落本文のフォント サイズです。 |
BodySubtle | Body と同じですが、不透明度が Subtle です。 |
Base | 段落本文のフォント サイズで、太字です。 基本的には、Body の太字バージョンと言えます。 |
BaseSubtle | Base と同じですが、不透明度が Subtle です。 |
Subtitle | H4 のフォント サイズです。 |
SubtitleSubtle | Subtitle と同じですが、不透明度が Subtle です。 |
Title | H3 のフォント サイズです。 |
TitleSubtle | Title と同じですが、不透明度が Subtle です。 |
TitleNumeral | Title と同じですが、上/下のパディングが削除されます。 |
Subheader | H2 のフォント サイズです。 |
SubheaderSubtle | Subheader と同じですが、不透明度が Subtle です。 |
SubheaderSubtle | Subheader と同じですが、上/下のパディングが削除されます。 |
Header | H1 のフォント サイズです。 |
HeaderSubtle | Header と同じですが、不透明度が Subtle です。 |
HeaderNumeral | Header と同じですが、上/下のパディングが削除されます。 |
AdaptiveTextAlign
テキストの水平方向の配置を制御します。
値 | 意味 |
---|---|
既定 | 既定値です。 配置がレンダラーによって自動的に決定されます。 |
Auto | 配置が現在の言語とカルチャによって決定されます。 |
Left | テキストを左側に水平方向に配置します。 |
Center | テキストを中央に水平方向に配置します。 |
Right | テキストを右側に水平方向に配置します。 |
AdaptiveImage
インライン画像です。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
ソース | string | true | 画像への URL です。 ms-appx、ms-appdata、および http がサポートされます。 Fall Creators Update の時点で、Web 画像の上限は通常の接続で 3 MB、従量制課金接続で 1 MB です。 まだ Fall Creators Update を実行していないデバイスでは、Web イメージは 200 KB を上限とします。 |
HintCrop | AdaptiveImageCrop | false | Anniversary Update の新機能: イメージの目的のトリミングを制御します。 |
HintRemoveMargin | bool? | false | 既定では、グループ/サブグループ内の画像には周囲に 8 ピクセルの余白があります。 このプロパティを true に設定することで余白を削除できます。 |
HintAlign | AdaptiveImageAlign | false | 画像の水平方向の配置です。 グループ/サブグループ内の画像にのみ機能します。 |
AlternateText | string | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100ms-contrast=standardms-lang=en-us" に変わります。 |
AdaptiveImageCrop
必要な画像トリミングを指定します。
値 | 意味 |
---|---|
既定 | 既定値です。 トリミングの動作がレンダラーによって決定されます。 |
なし | 画像がトリミングされません。 |
円 | 画像が円形にトリミングされます。 |
AdaptiveImageAlign
画像の水平方向の配置を指定します。
値 | 意味 |
---|---|
既定 | 既定値です。 配置の動作がレンダラーによって決定されます。 |
Stretch | 利用可能な幅いっぱいに画像が拡大されます (また同時に、画像が配置される位置に応じて、利用可能な高さいっぱいに拡大されることもあります)。 |
Left | 画像を左側に配置し、ネイディブの解像度で表示します。 |
Center | 画像を中央に水平方向に配置し、ネイティブの解像度で表示します。 |
Right | 画像を右側に配置し、ネイディブの解像度で表示します。 |
AdaptiveGroup
Anniversary Updateの新機能:グループは、グループ内のコンテンツについて、全体を表示すべきか、収まりきらない場合は全体を表示すべきでないかを意味的に識別します。 複数の列を作成することも可能にします。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
Children | IList<AdaptiveSubgroup> | false | サブグループが垂直方向の列として表示されます。 AdaptiveGroup 内の任意のコンテンツを提供するにはサブグループを使用する必要があります。 |
AdaptiveSubgroup
Anniversary Updateの新機能:サブグループは垂直方向の列で、テキストと画像を含めることができます。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
Children | IList<IAdaptiveSubgroupChild> | false | AdaptiveText と AdaptiveImage は、サブグループの有効な子です。 |
HintWeight | int? | false | 別のサブグループを基準として太さを指定することで、このサブグループの列の幅を制御します。 |
HintTextStacking | AdaptiveSubgroupTextStacking | false | このサブグループのコンテンツの垂直方向の配置を制御します。 |
IAdaptiveSubgroupChild
サブグループの子のマーカー インターフェイスです。
実装 |
---|
AdaptiveText |
AdaptiveImage |
AdaptiveSubgroupTextStacking
TextStacking は、コンテンツの垂直方向の配置を指定します。
値 | 意味 |
---|---|
既定 | 既定値です。 レンダラーが既定の垂直方向の配置を自動的に選択します。 |
上位 | 上に合わせて垂直に配置されます。 |
Center | 中央に合わせて垂直に配置されます。 |
下 | 下に合わせて垂直に配置されます。 |
AdaptiveProgressBar
Creators Update の新機能: 進行状況バー。 デスクトップ上のトーストでのみサポートされ、バージョン 15063 またはそれ以降のバージョン。
プロパティ | タイプ | Required | Description |
---|---|---|---|
Title | string または BindableString | false | オプションのタイトル文字列を取得または設定します。 データ バインディングをサポートします |
Value | double または AdaptiveProgressBarValue または BindableProgressBarValue | false | 進行状況バーの状態を取得または設定します。 データ バインディングをサポートします 既定値は 0 です。 |
ValueStringOverride | string または BindableString | false | 既定のパーセンテージ文字列の代わりに表示される省略可能な文字列を取得または設定します。 これが指定されていない場合は、"70%" のようなものが表示されます。 |
Status | string または BindableString | true | 左側の進行状況バーの下に表示される状態文字列 (必須) を取得または設定します。 この文字列は、"Downloading..."または "Installing..." のような操作の状態を反映している必要があります。 |
AdaptiveProgressBarValue
進行状況バーの値を表すクラス。
プロパティ | タイプ | Required | Description |
---|---|---|---|
Value | 倍精度浮動小数点 | false | 達成率を表す値 (0.0 ~ 1.0) を取得または設定します。 |
IsIndeterminate | [bool] | false | 進行状況バーが不確定かどうかを示す値を取得または設定します。 true の場合、 値 は無視されます。 |
BindableProgressBarValue
バインド可能な進行状況バーの値。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
BindingName | string | true | バインディング データ値にマップされる名前を取得または設定します。 |
ToastGenericAppLogo
アプリのロゴの代わりに表示されるロゴ。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
ソース | string | true | 画像への URL です。 ms-appx、ms-appdata、および http がサポートされます。 http の画像は、サイズを 200 KB 以下にする必要があります。 |
HintCrop | ToastGenericAppLogoCrop | false | 画像のトリミング方法を指定します。 |
AlternateText | string | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100ms-contrast=standardms-lang=en-us" に変わります。 |
ToastGenericAppLogoCrop
アプリロゴ画像のトリミングを制御します。
Value | 意味 |
---|---|
既定 | トリミングがレンダラーの既定の動作を使用します。 |
なし | 画像がトリミングされず、正方形で表示されます。 |
円 | 画像が円形にトリミングされます。 |
ToastGenericHeroImage
アクション センター内のトーストに表示される特色の "ヒーロー" 画像。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
ソース | string | true | 画像への URL です。 ms-appx、ms-appdata、および http がサポートされます。 http の画像は、サイズを 200 KB 以下にする必要があります。 |
AlternateText | string | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100ms-contrast=standardms-lang=en-us" に変わります。 |
ToastGenericAttributionText
トースト通知の下部に表示される属性テキスト。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
[テキスト] | string | true | 表示するテキスト。 |
Language | string | false | ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。 未指定の場合は、システム ロケールが代わりに使用されます。 |
IToastActions
トースト アクション/入力のマーカー インターフェイス。
実装 |
---|
ToastActionsCustom |
ToastActionsSnoozeAndDismiss |
ToastActionsCustom
Implements IToastActions
ボタン、テキスト ボックス、選択入力などのコントロールを使用して、独自のカスタム アクションと入力を作成します。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
入力 | IList<IToastInput> | false | テキスト ボックスや選択入力などの入力。 最大 5 つの入力のみが許可されます。 |
ボタン | IList<IToastButton> | false | ボタンは、すべての入力の後に表示されます (または、ボタンがクイック応答ボタンとして使用されている場合は入力に隣接します)。 最大 5 つのボタンのみが許可されます (コンテキスト メニュー項目がある場合は少なくなります)。 |
ContextMenuItems | IList<ToastContextMenuItem> | false | Anniversary Update の新機能: カスタム コンテキスト メニュー項目であり、ユーザーが通知を右クリックした場合に追加のアクションを提供します。 最大 5 つのボタンとコンテキスト メニュー項目 を組み合わせることができます。 |
IToastInput
トースト入力のマーカー インターフェイス。
実装 |
---|
ToastTextBox |
ToastSelectionBox |
ToastTextBox
Implements IToastInput
TextBox コントロールによって、ユーザーはアプリにテキストを入力できます。
プロパティ | タイプ | Required | 内容 |
---|---|---|---|
Id | string | true | ID は必須であり、ユーザー入力テキストを、後でアプリが使用する ID と値のキーと値のペアにマップするために使用されます。 |
Title | string | false | テキスト ボックスの上に表示するタイトル テキスト。 |
PlaceholderContent | string | false | ユーザーがまだテキストを入力していない場合にテキスト ボックスに表示されるプレースホルダー テキスト。 |
DefaultInput | string | false | テキスト ボックスに配置する最初のテキスト。 空白のテキスト ボックスの場合は、この null のままにします。 |
ToastSelectionBox
Implements IToastInput
ユーザーがオプションのドロップダウン リストから選択できる選択ボックス コントロール。
プロパティ | タイプ | Required | 内容 |
---|---|---|---|
Id | string | true | ID は必須です。 ユーザーがこの項目を選択した場合、この ID は、選択した選択内容を表すアプリのコードに返されます。 |
コンテンツ | string | true | コンテンツは必須であり、選択項目に表示される文字列です。 |
ToastSelectionBoxItem
選択ボックス項目 (ユーザーがドロップダウン リストから選択できる項目)。
プロパティ | タイプ | Required | 内容 |
---|---|---|---|
Id | string | true | ID は必須であり、ユーザー入力テキストを、後でアプリが使用する ID と値のキーと値のペアにマップするために使用されます。 |
Title | string | false | 選択ボックスの上に表示するタイトル テキスト。 |
DefaultSelectionBoxItemId | string | false | 既定で選択されている項目を制御し、ToastSelectionBoxItemの Id プロパティを参照します。 これを指定しない場合、既定の選択は空になります (ユーザーには何も表示されません)。 |
項目 | IList<ToastSelectionBoxItem> | false | この SelectionBox でユーザーが選択できる選択項目。 追加できるアイテムは 5 つだけです。 |
IToastButton
トースト ボタンのマーカー インターフェイス。
実装 |
---|
ToastButton |
ToastButtonSnooze |
ToastButtonDismiss |
ToastButton
Implements IToastButton
ユーザーがクリックできるボタン。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
コンテンツ | string | true | 必須。 ボタンに表示されるテキスト。 |
引数 | string | true | 必須。 ユーザーがこのボタンをクリックした場合にアプリが後で受け取る引数のアプリ定義文字列。 |
ActivationType | ToastActivationType | false | このボタンをクリックしたときに使用するアクティブ化の種類を制御します。 既定値は Foreground です。 |
ActivationOptions | ToastActivationOptions | false | Creators Update の新機能: トースト ボタンのアクティブ化に関連する追加オプションを取得または設定します。 |
ToastActivationType
ユーザーが特定のアクションを操作するときに使用されるアクティブ化の種類を決定します。
Value | 意味 |
---|---|
前景 | 既定値です。 フォアグラウンド アプリが起動します。 |
背景 | 対応するバックグラウンド タスク (すべてを設定した場合) がトリガーされ、ユーザーを中断することなくバックグラウンドでコードを実行できます (ユーザーのクイック応答メッセージの送信など)。 |
プロトコル | プロトコルのアクティブ化を使用して別のアプリを起動します。 |
ToastActivationOptions
Creators Update の新機能: アクティブ化に関連する追加オプション。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
AfterActivationBehavior | ToastAfterActivationBehavior | false | Fall Creators Update の新機能: ユーザーがこのアクションを呼び出すときにトーストが使用する動作を取得または設定します。 これは、ToastButtonおよび ToastContextMenuItemのデスクトップでのみ機能します |
ProtocolActivationTargetApplicationPfn | string | false | ToastActivationType.Protocolを使用している場合は、必要に応じてターゲット PFN を指定できます。そのため、同じプロトコル URI を処理するために複数のアプリが登録されているかどうかに関係なく、目的のアプリが常に起動されます。 |
ToastAfterActivationBehavior
ユーザーがトーストに対してアクションを実行するときにトーストが使用する動作を指定します。
Value | 意味 |
---|---|
既定値 | 既定の動作 ユーザーがトーストに対してアクションを実行すると、トーストは無視されます。 |
PendingUpdate | ユーザーがトーストのボタンをクリックすると、通知は "保留中の更新" 表示状態で再メイン表示されます。 バックグラウンド タスクからトーストを直ちに更新して、ユーザーにこの "保留中の更新" の表示状態が長時間表示されないようにする必要があります。 |
ToastButtonSnooze
Implements IToastButton
通知のスヌーズを自動的に処理するシステム処理の再通知ボタン。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
CustomContent | string | false | 既定のローカライズされた "再通知" テキストをオーバーライドするボタンに表示されるオプションのカスタム テキスト。 |
ToastButtonDismiss
Implements IToastButton
クリックされたときに通知を閉じるシステム処理の閉じるボタン。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
CustomContent | string | false | 既定のローカライズされた "無視" テキストをオーバーライドするボタンに表示されるオプションのカスタム テキスト。 |
ToastActionsSnoozeAndDismiss
Implements IToastActions
再通知間隔の選択ボックスを自動的に作成し、再通知/閉じるボタンをすべて自動的にローカライズし、スヌーズ ロジックはシステムによって自動的に処理されます。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
ContextMenuItems | IList<ToastContextMenuItem> | false | Anniversary Update の新機能: カスタム コンテキスト メニュー項目であり、ユーザーが通知を右クリックした場合に追加のアクションを提供します。 アイテムは最大 5 個までです。 |
ToastContextMenuItem
コンテキスト メニュー項目のエントリ。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
コンテンツ | string | true | 必須。 表示するテキスト。 |
引数 | string | true | 必須。 ユーザーがメニュー項目をクリックしたときにアクティブ化されると、アプリが後で取得できる引数のアプリ定義文字列。 |
ActivationType | ToastActivationType | false | このメニュー項目がクリックされたときに使用するアクティブ化の種類を制御します。 既定値は Foreground です。 |
ActivationOptions | ToastActivationOptions | false | Creators Update の新機能: トースト コンテキスト メニュー項目のアクティブ化に関連する追加オプション。 |
トーストオーディオ
トースト通知を受信したときに再生するオーディオを指定します。
プロパティ | タイプ | Required | 説明 |
---|---|---|---|
Src | uri | false | 既定のサウンドの代わりに再生するメディア ファイル。 ms-appx と ms-resource だけがサポートされています。 それ以外 (ms-appdata、http、C:など) はサポートされていません。 |
Loop | boolean | false | トーストが表示されている限りサウンドを繰り返す必要がある場合は true に設定します。1 回だけ再生する場合は false (既定値)。 |
Silent | boolean | false | サウンドをミュートする場合は True。トースト通知サウンドの再生を許可する場合は false (既定値)。 |
トーストヘッダー
Creators Update の新機能: アクション センター内で複数の通知をグループ化するカスタム ヘッダー。
プロパティ | タイプ | Required | 内容 |
---|---|---|---|
Id | string | true | このヘッダーを一意に識別する開発者が作成した識別子。 2 つの通知のヘッダー ID が同じである場合は、アクション センターの同じヘッダーの下に表示されます。 |
Title | string | true | ヘッダーのタイトル。 |
引数 | string | true | ユーザーがこのヘッダーをクリックしたときにアプリに返される、開発者が定義した引数の文字列を取得または設定します。 null にすることはできません。 |
ActivationType | ToastActivationType | false | このヘッダーがクリックされたときに使用するアクティブ化の種類を取得または設定します。 既定値は Foreground です。 フォアグラウンドとプロトコルのみがサポートされていることに注意してください。 |
ActivationOptions | ToastActivationOptions | false | トースト ヘッダーのアクティブ化に関連する追加のオプションを取得または設定します。 |
関連トピック
Windows developer