AppNotificationBuilder.AddArgument(String, String) 方法

定义

命名空间:

Microsoft.Windows.AppNotifications.Builder

将由键/值对组成的参数添加到应用通知的 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

返回 AppNotificationBuilder 实例，以便可以链接其他方法调用。

示例

下面的示例演示如何使用此方法向应用通知添加参数。

var notification = new AppNotificationBuilder()
    .AddText("Send a message.")
    .AddTextBox("textBox")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

生成的 XML 有效负载：

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

注解

当用户单击通知时，使用此方法添加的应用通知参数将传递给激活的应用程序。 可以将多个参数添加到每个通知。 通过访问 AppNotificationActivatedEventArgs.Arguments 属性来检索随此方法添加的参数。

有关使用 AppNotificationBuilder API 创建应用通知的 UI 的指导，请参阅 应用通知内容。

有关应用通知的 XML 架构的参考信息，请参阅 应用通知内容架构。