Unblu Agent Embedded JS API
    Preparing search index...

    Interface MessageNotification

    Notification about a new message in a conversation.

    interface MessageNotification {
        actions: NotificationAction[];
        body: string;
        closeRequested: Promise<void>;
        conversationId: string;
        conversationNotificationCount: number;
        groupId?: string;
        imageUrl?: string;
        messageId: string;
        personNotificationCount: number;
        senderName: string;
        sticky: boolean;
        title: string;
        type: MESSAGE;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actions body closeRequested conversationId conversationNotificationCount groupId? imageUrl? messageId personNotificationCount senderName sticky title type

    Properties

    actions: NotificationAction[]

    Actions that can be executed on the notification (e.g. accepting or declining a call)

    body

    body: string

    The body of the notification

    closeRequested: Promise<void>

    A promise that resolves as soon as a notification is withdrawn and shouldn't be displayed anymore

    conversationId: string

    The ID of the related conversation of the notification

    conversationNotificationCount: number

    The notification count for the related conversation

    groupId?: string

    Identifier used to group related notifications of the same type (e.g. message notifications are grouped by conversation ID). For example use it as the tag field in WebNotifications to replace the previous "new message" notification for that conversation.

    https://developer.mozilla.org/en-US/docs/Web/API/Notification/tag

    imageUrl?: string

    An image which can be displayed on the notification

    messageId: string

    The ID of the message which was sent

    personNotificationCount: number

    The overall notification count of the current person

    senderName: string

    The name of the sender of the message

    sticky: boolean

    Defines whether the user should be able to dismiss the notification. If 'true', the notification can't be dismissed.

    title: string

    The title of the notification

    type: MESSAGE

    The type of notification. Used to distinguish between call, message, and other notifications.

    Settings

    Member Visibility

    On This Page

    Properties