PushNotificationReceivedEventArgs クラス

定義

アプリ サーバーから受信したプッシュ通知をカプセル化し、種類を識別し、通知の内容を指定します。 Windows は PushNotificationReceived イベントでこの情報を渡します。

public ref class PushNotificationReceivedEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class PushNotificationReceivedEventArgs final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PushNotificationReceivedEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class PushNotificationReceivedEventArgs
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PushNotificationReceivedEventArgs
Public NotInheritable Class PushNotificationReceivedEventArgs
継承
Object Platform::Object IInspectable PushNotificationReceivedEventArgs
属性

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能
internetClient

次の例は、使用中のこのクラスのメンバーを示しています。

function listeningForPushNotification() {
    if (channel) {
        channel.addEventListener("pushnotificationreceived", pushNotificationReceivedHandler);
}

function pushNotificationReceivedHandler(e) {
    var notificationTypeName = "";
    var notificationPayload;
    switch (e.notificationType) {
        // You can get the toast, tile, or badge notification object.
        // In this example, we take the XML from the notification.
        case pushNotifications.PushNotificationType.toast:
            notificationTypeName = "Toast";
            notificationPayload = e.toastNotification.content.getXml();
            break;
        case pushNotifications.PushNotificationType.tile:
            notificationTypeName = "Tile";
            notificationPayload = e.tileNotification.content.getXml();
            break;
        case pushNotifications.PushNotificationType.badge:
            notificationTypeName = "Badge";
            notificationPayload = e.badgeNotification.content.getXml();
            break;
    }
    e.cancel = true;
}

注釈

アプリは、PushNotificationReceived イベントを処理するときにこのクラスを受け取ります。

プロパティ

BadgeNotification

このプッシュ通知に応答して実行するバッジ更新の内容を取得します。

Cancel

Windows が通知の既定の処理を実行する必要があるかどうかを取得または設定します。

NotificationType

アプリ サーバーから受信したプッシュ通知の種類を取得します。

RawNotification

このプッシュ通知に含まれるアプリ定義コンテンツを取得します。このコンテンツは、アプリでバックグラウンド タスクを実行するために使用されます。

TileNotification

このプッシュ通知に応答して実行するタイル更新の内容を取得します。

ToastNotification

このプッシュ通知に応答して表示するトーストの内容を取得します。

適用対象

こちらもご覧ください