itd-api / NotificationsApi

Interface: NotificationsApi

Defined in: notifications-api.ts:6

Уведомления полного клиента: REST-методы и стабильный канал событий.

Extends

• NotificationsResource

Properties

events

readonly events: NotificationEvents;

Defined in: notifications-api.ts:8

Один канал событий уведомлений на всё время жизни клиента.

Methods

count()

count(options?): Promise<number>;

Defined in: resources/notifications.ts:137

Загружает число непрочитанных уведомлений.

Parameters

options?

RequestOptions = {}

Returns

Promise<number>

Inherited from

NotificationsResource.count

---

getSettings()

getSettings(options?): Promise<NotificationSettings>;

Defined in: resources/notifications.ts:190

Загружает настройки уведомлений.

Parameters

options?

RequestOptions = {}

Returns

Promise<NotificationSettings>

Inherited from

NotificationsResource.getSettings

---

iterate()

iterate(params?, options?): Paginator<Notification>;

Defined in: resources/notifications.ts:129

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

Parameters

params?

NotificationListParams = {}

options?

PaginationOptions = {}

Returns

Paginator<Notification>

Example

for await (const notification of itd.notifications.iterate()) {
  console.log(formatNotificationText(notification));
}

Inherited from

NotificationsResource.iterate

---

list()

list(params?, options?): Promise<Page<Notification>>;

Defined in: resources/notifications.ts:112

Загружает страницу уведомлений.

Пагинация здесь основана на смещении.

Parameters

params?

NotificationListParams = {}

options?

RequestOptions = {}

Returns

Promise<Page<Notification>>

Example

const page = await itd.notifications.list({ limit: 20 });
const next = await itd.notifications.list({ limit: 20, offset: page.nextOffset });

Inherited from

NotificationsResource.list

---

markAllRead()

markAllRead(options?): Promise<number>;

Defined in: resources/notifications.ts:182

Отмечает прочитанными все уведомления.

Parameters

options?

RequestOptions = {}

Returns

Promise<number>

Inherited from

NotificationsResource.markAllRead

---

markRead()

markRead(notificationId, options?): Promise<number>;

Defined in: resources/notifications.ts:149

Отмечает уведомление прочитанным.

Parameters

notificationId

string

options?

RequestOptions = {}

Returns

Promise<number>

сколько записей отметил сервер

Inherited from

NotificationsResource.markRead

---

markReadBatch()

markReadBatch(ids, options?): Promise<number>;

Defined in: resources/notifications.ts:165

Отмечает прочитанными сразу несколько уведомлений.

Список автоматически режется на части по 20 идентификаторов — столько же отправляет сайт итд.com, поэтому на сервере вероятен предел. Части уходят последовательно, результат суммируется.

Parameters

ids

string[]

options?

RequestOptions = {}

Returns

Promise<number>

сколько записей отметил сервер суммарно

Inherited from

NotificationsResource.markReadBatch

---

updateSettings()

updateSettings(input, options?): Promise<NotificationSettings>;

Defined in: resources/notifications.ts:202

Обновляет настройки уведомлений.

Отправляются только изменяемые поля, в том же виде, в каком сервер их возвращает.

Parameters

input

UpdateNotificationSettingsInput

options?

RequestOptions = {}

Returns

Promise<NotificationSettings>

Inherited from

NotificationsResource.updateSettings