OXBOX Help

Chat

Модуль выводит чат для взаимодействия с другими пользователями системы. Имеет следующую структуру:

{ type: "chat", size: number, settings: { groups: { object: string, property: string }, chats: { obejct: string, property: string }, messages: { object: string } } }
  • groups - объект, содержащий свойство object - объект для запроса списка групп чатов и свойство property, содержащее артикул, под которым необходимо передавать значение выбранной группы при дочернем запросе (chats).

  • chats - объект, содержащий свойство object - объект для запроса списка чатов и свойство property, содержащее артикул, под которым необходимо передавать значение выбранной группы при дочернем запросе (messages).

  • messages - объект, содержащий единственное свойство object - объект для запроса списка сообщений.

В ответ на запрос списка групп чатов ожидаются объекты со следующей структурой:

{ title: string, id: number }
  • title - заголовок группы чатов.

  • id - идентификатор группы чатов.

В ответ на запрос списка чатов ожидаются объекты со следующей структурой:

{ title: string, id: number, unread_messages_count?: number }
  • title - заголовок чата.

  • id - идентификатор чата.

  • unread_messages_count - количество непрочитанных сообщений в чате.

Ожидаемая структура объекта сообщения при запросе списка сообщений чата:

{ id: number, message: string, user_id: { title: string, value: number } | null }
  • id - идентификатор сообщения.

  • message - текстовая часть сообщения.

  • user_id - автор сообщения, представленный в виде объекта со свойствами title и value (идентификатор автора) или типа null.

15 мая 2025