itd-api / Notification

Interface: Notification

Defined in: models/notifications.ts:15

Уведомление в единой форме.

REST-список и SSE-поток отдают уведомления по-разному — разные имена типов, разные имена полей, один участник против массива. Библиотека приводит оба вида к этой структуре, поэтому объекты из itd.notifications.list() и из потока можно складывать в один список.

Исходные данные не теряются: серверное имя типа остаётся в rawType, а весь необработанный объект — в raw.

Properties

actors

actors: Actor[];

Defined in: models/notifications.ts:28

Кто совершил действие. Для схлопнутых уведомлений — несколько человек.

---

clickUrl?

optional clickUrl?: string;

Defined in: models/notifications.ts:34

Ссылка перехода, предложенная сервером. Обычно точнее её resolveNotificationUrl().

---

count

count: number;

Defined in: models/notifications.ts:30

Сколько участников схлопнуто в одно уведомление. Минимум 1.

---

createdAt

createdAt: string;

Defined in: models/notifications.ts:35

---

entityId

entityId: string | null;

Defined in: models/notifications.ts:22

Объект события: пост, комментарий, пользователь.

---

id

id: string;

Defined in: models/notifications.ts:16

---

isRead

isRead: boolean;

Defined in: models/notifications.ts:26

Прочитано ли уведомление.

---

parentEntityId

parentEntityId: string | null;

Defined in: models/notifications.ts:24

Пост, которому принадлежит комментарий, если событие о комментарии.

---

preview

preview: string | null;

Defined in: models/notifications.ts:32

Текст или заголовок объекта события.

---

raw

raw: unknown;

Defined in: models/notifications.ts:39

Исходный объект как он пришёл от сервера.

---

rawType

rawType: string;

Defined in: models/notifications.ts:20

Имя типа в том виде, в каком его прислал сервер.

---

type

type: NotificationType;

Defined in: models/notifications.ts:18

Канонический тип. Старые имена (like, comment) приведены к новым.

---

updatedAt

updatedAt: string;

Defined in: models/notifications.ts:37

Когда уведомление изменилось — например было прочитано.