ping-identity
    Preparing search index...

    Type Alias PushNotification

    A push MFA notification received from the server.

    Returned by PushClient.processNotification, PushClient.processNotificationFromMessage, PushClient.getNotification, PushClient.getPendingNotifications, and PushClient.getAllNotifications.

    The numbersChallenge field is a raw comma-separated string (e.g. "12,34,56"). Use getNumbersChallenge (exported from @ping-identity/rn-push) to parse it into number[].

    const notification = await client.processNotification(messageData);
    if (notification?.pushType === 'challenge') {
      const numbers = getNumbersChallenge(notification);
    }
    type PushNotification = {
        approved: boolean;
        challenge: string | null;
        contextInfo: string | null;
        createdAt: number;
        credentialId: string;
        customPayload: string | null;
        id: string;
        loadBalancer: string | null;
        messageId: string;
        messageText: string | null;
        numbersChallenge: string | null;
        pending: boolean;
        pushType: PushType;
        respondedAt: number | null;
        sentAt: number | null;
        ttl: number;
    }
    Index

    Properties

    approved challenge contextInfo createdAt credentialId customPayload id loadBalancer messageId messageText numbersChallenge pending pushType respondedAt sentAt ttl

    Properties

    approved: boolean

    Whether the notification was approved by the user.

    challenge: string | null

    Optional string challenge used for 'challenge' type notifications.

    contextInfo: string | null

    Optional serialized context info string from the server payload.

    createdAt: number

    Notification creation timestamp in milliseconds since epoch.

    credentialId: string

    Identifier of the credential this notification belongs to.

    customPayload: string | null

    Optional custom payload string forwarded from the server.

    id: string

    Unique notification identifier.

    loadBalancer: string | null

    Optional load balancer hint sent with the notification payload.

    messageId: string

    Unique message identifier from the push payload.

    messageText: string | null

    Optional human-readable message text for display.

    numbersChallenge: string | null

    Raw comma-separated numbers challenge string (e.g. "12,34,56").

    Only populated for pushType === 'challenge' notifications that use the numbers-matching flow. Parse with getNumbersChallenge(notification).

    pending: boolean

    Whether the notification is still pending a response.

    pushType: PushType

    Push notification type discriminator.

    respondedAt: number | null

    Optional timestamp when the notification was responded to, in milliseconds since epoch.

    sentAt: number | null

    Optional timestamp when the notification was sent, in milliseconds since epoch.

    ttl: number

    Time-to-live for the notification in seconds.

    Settings

    Member Visibility

    On This Page

    Properties