AppNotificationBuilder.AddArgument(String, String) メソッド

定義

キーと値のペアで構成される引数を、アプリ通知の XML ペイロードに追加します。

public:
 virtual AppNotificationBuilder ^ AddArgument(Platform::String ^ key, Platform::String ^ value) = AddArgument;
AppNotificationBuilder AddArgument(winrt::hstring const& key, winrt::hstring const& value);
public AppNotificationBuilder AddArgument(string key, string value);
function addArgument(key, value)
Public Function AddArgument (key As String, value As String) As AppNotificationBuilder

パラメーター

key
String

Platform::String

winrt::hstring

引数のキーを含む文字列。

value
String

Platform::String

winrt::hstring

引数の値を含む文字列。

返品

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

次の例は、 AddArgument を使用してアプリ通知にキー/値引数を追加する方法を示しています。

var notification = new AppNotificationBuilder()
    .AddArgument("conversationId", "9813")
    .AddText("Photos from our trip")
    .AddText("Check out these pictures of our trip!")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast launch='conversationId=9813'>
    <visual>
        <binding template='ToastGeneric'>
            <text>Photos from our trip</text>
            <text>Check out these pictures of our trip!</text>
        </binding>
    </visual>
</toast>

注釈

このメソッドで追加されたアプリ通知引数は、ユーザーが通知をクリックしたときにアクティブ化されたアプリケーションに渡されます。 各通知に複数の引数を追加できます。 AppNotificationActivatedEventArgs.Arguments プロパティにアクセスして、このメソッドで追加された引数を取得します。

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

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

適用対象