AppNotificationBuilder.SetGroup(String) メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知のグループ識別子を設定します。

public:
 virtual AppNotificationBuilder ^ SetGroup(Platform::String ^ group) = SetGroup;

AppNotificationBuilder SetGroup(winrt::hstring const& group);

public AppNotificationBuilder SetGroup(string group);

function setGroup(group)

Public Function SetGroup (group As String) As AppNotificationBuilder

パラメーター

group

String

Platform::String

winrt::hstring

アプリ通知が属するグループを識別する文字列。

戻り値

AppNotificationBuilder

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

例

次の例は、アプリ通知のグループを設定する方法を示しています。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetGroup("Notification group")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

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

グループ別に Notification Center からすべての通知を削除する例。

await AppNotificationManager.Default.RemoveByGroupAsync("Notification group");

注釈

グループ識別子を使用すると、AppNotificationManager.RemoveByGroupAsync呼び出すことによって、グループ内のすべてのアプリ通知を通知センターから削除できます。

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

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