Счетчик непрочитанных событий

getUnreadCounter

SDK 1.7iOS 3.15Android 3.15Web 3.15

Метод получения счетчика непрочитанных событий.

Аргументы

Параметр	Тип данных	Описание
type	"user" | "chat" | "smartapp"	Тип источника данных
id	string	Идентификатор источника: при type = "user", значение берется из user_huid; при type = "chat", значение берется из group_chat_id; при type = "smartapp", значение берется из app_id

Возвращаемое значение

Возвращаемое значение содержит Promise, который после исполнения вернет ответ, содержащий объект с атрибутом payload. В этом объекте содержится свойство unreadCounter.

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const type = "user";
    const id = "49bd5cac-a9b3-4d6f-b950-640f5b2a9f7c";

    const response = await SDK.getUnreadCounter({ type, id });

    // TODO: обработать response.payload.unreadCounter
  } catch(error) {
    console.log(error);
  }
}

subscribeClientEvents

SDK 1.7iOS 3.15Android 3.15Web 3.15

Метод подписки на изменение счетчика непрочитанных событий.

Аргументы

Параметр	Тип данных	Описание
type	string	"unread_counter_change"
payload	object	Объект, содержащий идентификаторы источника
- payload.type	"user" | "chat" | "smartapp"	Тип источника данных
- payload.id	string	Идентификатор источника
callback	function	Метод, вызываемый при изменении счетчика (опционально)

Возвращаемое значение

Возвращаемое значение содержит Promise, который будет исполнен.

Пример:

import * as SDK from "@expressms/smartapp-sdk";

function counterChangeCallback(event) {
  // TODO: обработать event.payload.unreadCounter и event.payload.source
}

async function test() {
  try {
    const type = "user";
    const id = "49bd5cac-a9b3-4d6f-b950-640f5b2a9f7c";

    await SDK.subscribeClientEvents({
      type: "unread_counter_change",
      payload: {
        type,
        id,
      }
      callback: counterChangeCallback,
    });
  } catch(error) {
    console.log(error);
  }
}

unsubscribeClientEvents

SDK 1.7iOS 3.15Android 3.15Web 3.15

Метод отмены подписки на изменение счетчика непрочитанных событий.

Аргументы

Параметр	Тип данных	Описание
type	string	"unread_counter_change"
payload	object	Объект, содержащий идентификаторы источника
- payload.type	"user" | "chat" | "smartapp"	Тип источника данных
- payload.id	string	Идентификатор источника
callback	function	Метод, вызываемый при изменении счетчика (опционально)

Возвращаемое значение

Возвращаемое значение содержит Promise, который будет исполнен.

Пример:

import * as SDK from "@expressms/smartapp-sdk";

function counterChangeCallback(event) {
  // ...
}

async function test() {
  try {
    const type = "user";
    const id = "49bd5cac-a9b3-4d6f-b950-640f5b2a9f7c";

    await SDK.unsubscribeClientEvents({
      type: "unread_counter_change",
      payload: {
        type,
        id,
      }
      callback: counterChangeCallback,
    });
  } catch(error) {
    console.log(error);
  }
}