AppNotificationBuilder.SetScenario(AppNotificationScenario) メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知のシナリオを設定します。これにより、システムは一部の通知動作を調整して、指定したシナリオに一貫したエクスペリエンスを提供します。

public:
 virtual AppNotificationBuilder ^ SetScenario(AppNotificationScenario value) = SetScenario;

AppNotificationBuilder SetScenario(AppNotificationScenario const& value);

public AppNotificationBuilder SetScenario(AppNotificationScenario value);

function setScenario(value)

Public Function SetScenario (value As AppNotificationScenario) As AppNotificationBuilder

パラメーター

value

AppNotificationScenario

アプリ通知の AppNotificationScenario シナリオを指定する 列挙体の値。

戻り値

AppNotificationBuilder

追加のメソッド呼び出しをチェーンできるように、 AppNotificationBuilder インスタンスを返します。

例

次の例では、アプリ通知の XML ペイロードで通知シナリオを設定する方法を示します。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetScenario(AppNotificationScenario.Reminder)
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast scenario='reminder'>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
</toast>

注釈

緊急シナリオの値は、Windows 10 ビルド 19041 以降でのみサポートされます。 IsUrgentScenarioSupported を呼び出して、緊急のシナリオが現在のデバイスでサポートされているかどうかを実行時に判断します。

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法のガイダンスについては、「アプリ通知コンテンツ」を参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知 コンテンツ スキーマ」を参照してください。