Interface NotificationResponse

export NotificationResponse

interface NotificationResponse {
    action_uri?: null | string;
    avatar_url?: null | string;
    created_at?: string;
    data_id?: null | string;
    data_type?: null | string;
    from_persona_id?: null | string;
    icon_url?: null | string;
    id?: null | string;
    is_read?: boolean;
    is_urgent?: boolean;
    message?: null | string;
    object?: null | string;
    short_id?: null | string;
    style_type?: NotificationStyleTypes;
    title?: null | string;
    to_persona_id?: null | string;
    to_persona_name?: null | string;
}

Properties

action_uri? avatar_url? created_at? data_id? data_type? from_persona_id? icon_url? id? is_read? is_urgent? message? object? short_id? style_type? title? to_persona_id? to_persona_name?

Properties

Optionalaction_uri

action_uri?: null | string

A url this notification is linked to. Often this is where to send the client when the notification is clicked.

Optionalavatar_url

avatar_url?: null | string

The URL for the avatar of the personna that triggered this notification to send

Optionalcreated_at

created_at?: string

The date the notification was created

Optionaldata_id

data_id?: null | string

Id of the original data used to fetch relevant details

Optionaldata_type

data_type?: null | string

The type of data stored in 'data'

Optionalfrom_persona_id

from_persona_id?: null | string

The ID for the persona that triggered this notification to send, if not a system/platform notification

Optionalicon_url

icon_url?: null | string

A url pointing to an icon to display with the notification

Optionalid

id?: null | string

Optionalis_read

is_read?: boolean

True if the notification is read, and false if it is unread

Optionalis_urgent

is_urgent?: boolean

True if the notification is marked urgent

Optionalmessage

message?: null | string

The actual notification message

Optionalobject

object?: null | string

The name of this object

Optionalshort_id

short_id?: null | string

A short identifier for the notification

Optionalstyle_type

style_type?: NotificationStyleTypes

Optionaltitle

title?: null | string

Title of the notification

Optionalto_persona_id

to_persona_id?: null | string

The ID for the persona this notification is directed towards

Optionalto_persona_name

to_persona_name?: null | string

The display name for the persona this notification is directed towards

Settings

Member Visibility

On This Page

Properties