Lime Web Components API Documentation - v7.11.0
    Preparing search index...

    Type Alias Notification<T>Beta

    A Notification object

    type Notification<T = unknown> = {
        createdBy?: LimeObject;
        data?: T;
        highlight?: LimeObject;
        id: number;
        limeobject?: LimeObject;
        read?: Date;
        timestamp: Date;
        type?: NotificationType;
    }

    Type Parameters

    • T = unknown
    Index

    Properties

    createdBy?: LimeObject

    The coworker that created the notification

    data?: T

    Data attached to the notification

    highlight?: LimeObject

    The item to highlight in Notification.limeobject's activity feed when the notification is opened: the history note, document or to-do. Loaded through NotificationRepository.loadBundles, it is absent when the notification is about limeobject itself. Loaded through NotificationRepository.loadAll, a mention has the item it was written in as both limeobject and highlight.

    id: number

    The notification id

    limeobject?: LimeObject

    The object the notification is about, such as the history note a mention was written in. A notification loaded through NotificationRepository.loadBundles has its bundle's object instead: the object to open, whose activity feed shows what the notification is about.

    read?: Date

    Date when the notification was marked as read

    timestamp: Date

    Date when the notification was created

    Type of notification