itd-api / NotificationEventsMap

Interface: NotificationEventsMap<C>

Defined in: events/stream.ts:50

События потока уведомлений.

Общая часть — EventChannelEvents: статусы, ошибки и переподключение одинаковы у любого потока. Ниже — то, что есть только у уведомлений.

Extends

• EventChannelEvents<C>

Type Parameters

C

C extends NotificationEventContext = NotificationEventContext

Properties

error

error: object;

Defined in: events/engine.ts:53

Соединение оборвалось; будет предпринята попытка переподключения.

error

error: unknown;

willReconnect

willReconnect: boolean;

Inherited from

EventChannelEvents.error

---

giveup

giveup: undefined;

Defined in: events/engine.ts:59

Попытки исчерпаны — соединение восстановится только ручным connect().

Inherited from

EventChannelEvents.giveup

---

handlerError

handlerError: object;

Defined in: events/engine.ts:65

Обработчик обновления завершился исключением.

context

context: C;

error

error: unknown;

Inherited from

EventChannelEvents.handlerError

---

message

message: EventTransportFrame;

Defined in: events/engine.ts:61

Любой исходный кадр транспорта. Отправляется до нормализации и обработчиков.

Inherited from

EventChannelEvents.message

---

middlewareError

middlewareError: object;

Defined in: events/engine.ts:63

Промежуточный обработчик потока завершился исключением.

context

context: C;

error

error: unknown;

Inherited from

EventChannelEvents.middlewareError

---

notification

notification: NotificationEvent;

Defined in: events/stream.ts:54

Пришло новое уведомление.

---

parseError

parseError: object;

Defined in: events/engine.ts:55

Сообщение не удалось разобрать. Соединение при этом продолжает работать.

error

error: unknown;

raw

raw: string;

Inherited from

EventChannelEvents.parseError

---

ready

ready: object;

Defined in: events/stream.ts:60

Сервер подтвердил подключение и назвал получателя событий.

Приходит первым кадром сразу после установки соединения.

userId

userId: string | undefined;

---

reconnect

reconnect: object;

Defined in: events/engine.ts:57

Запланировано переподключение.

attempt

attempt: number;

delay

delay: number;

Inherited from

EventChannelEvents.reconnect

---

status

status: EventChannelStatus;

Defined in: events/engine.ts:51

Изменилось состояние соединения.

Inherited from

EventChannelEvents.status

---

unreadCount

unreadCount: number;

Defined in: events/stream.ts:68

Получено актуальное число непрочитанных.

При подключении клиент может запросить начальное значение через REST. Затем событие возникает, только если счётчик пришёл в потоке. В остальных случаях обновляйте его в приложении либо запрашивайте itd.notifications.count().