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