itd-api / Notification

Interface: Notification

Defined in: models/notifications.ts:15

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

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

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

Properties

actors

ts

actors: Actor[];

Defined in: models/notifications.ts:28

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

clickUrl?

ts

optional clickUrl?: string;

Defined in: models/notifications.ts:34

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

count

ts

count: number;

Defined in: models/notifications.ts:30

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

createdAt

ts

createdAt: string;

Defined in: models/notifications.ts:41

entityId

ts

entityId: string | null;

Defined in: models/notifications.ts:22

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

eventId

ts

eventId: string | null;

Defined in: models/notifications.ts:38

Ивент, к которому относится уведомление, иначе null.

expiresAt

ts

expiresAt: string | null;

Defined in: models/notifications.ts:40

До какого момента уведомление актуально, иначе null.

id

ts

id: string;

Defined in: models/notifications.ts:16

isRead

ts

isRead: boolean;

Defined in: models/notifications.ts:26

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

parentEntityId

ts

parentEntityId: string | null;

Defined in: models/notifications.ts:24

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

preview

ts

preview: string | null;

Defined in: models/notifications.ts:32

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

raw

ts

raw: unknown;

Defined in: models/notifications.ts:45

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

rawType

ts

rawType: string;

Defined in: models/notifications.ts:20

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

title

ts

title: string | null;

Defined in: models/notifications.ts:36

Заголовок уведомления, если сервер его задал, иначе null.

type

ts

type: NotificationType;

Defined in: models/notifications.ts:18

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

updatedAt

ts

updatedAt: string;

Defined in: models/notifications.ts:43

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