Interface IInboxNotification

interface IInboxNotification {
    body: string;
    date: Date;
    hasLandingMessage: boolean;
    iOSAttachmentURL?: string;
    identifier: string;
    isUnread: boolean;
    payload: unknown;
    source: NotificationSource;
    title?: string;
}

Properties

body date hasLandingMessage iOSAttachmentURL? identifier isUnread payload source title?

Properties

body

body: string

Notification alert body

date

date: Date

Date at which the push notification has been sent to the device

hasLandingMessage

hasLandingMessage: boolean

Flag indicating whether this notification has a landing message attached.

OptionaliOSAttachmentURL

iOSAttachmentURL?: string

URL of the rich notification attachment (image/audio/video) - iOS Only

identifier

identifier: string

Unique notification identifier. Do not make assumptions about its format: it can change at any time.

isUnread

isUnread: boolean

Flag indicating whether this notification is unread or not

payload

payload: unknown

Raw notification user data (also called payload)

source

source: NotificationSource

The push notification's source, indicating what made Batch send it. It can come from a push campaign via the API or the dashboard, or from the transactional API, for example.

Optionaltitle

title?: string

Notification title (if present)

Settings

Member Visibility

On This Page

Properties