itd-api / RealtimeEvents

Interface: RealtimeEvents

Defined in: realtime/stream.ts:23

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

Properties

error

error: object;

Defined in: realtime/stream.ts:43

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

error

error: unknown;

willReconnect

willReconnect: boolean;

---

giveup

giveup: undefined;

Defined in: realtime/stream.ts:49

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

---

message

message: object;

Defined in: realtime/stream.ts:51

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

data

data: unknown;

name

name: string;

---

notification

notification: NotificationEvent;

Defined in: realtime/stream.ts:25

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

---

parseError

parseError: object;

Defined in: realtime/stream.ts:45

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

error

error: unknown;

raw

raw: string;

---

ready

ready: object;

Defined in: realtime/stream.ts:31

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

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

userId

userId: string | undefined;

---

reconnect

reconnect: object;

Defined in: realtime/stream.ts:47

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

attempt

attempt: number;

delay

delay: number;

---

status

status: RealtimeStatus;

Defined in: realtime/stream.ts:41

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

---

unreadCount

unreadCount: number;

Defined in: realtime/stream.ts:39

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

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