chatService

chatService

• chatService
  • GetPaginatedWorkerChats(queryString) ⇒ Promise.<ApiResult>
  • GetChatsByUserId(queryString) ⇒ Promise.<ApiResult>
  • GetMessagesByChatId(queryString) ⇒ Promise.<ApiResult>
  • GetUnreadMessagesCount() ⇒ Promise.<ApiResult>
  • WriteMessageAndAddUserIntoOpenChat(params) ⇒ Promise.<ApiResult>
  • ClearUnreadMessageForUser(chatId) ⇒ Promise.<ApiResult>
  • GetChatById(params) ⇒ Promise.<ApiResult>
  • GetChatInfoById(chatId) ⇒ Promise.<ApiResult>
  • GetAlreadyCloseChatsWithUsers(groupId) ⇒ Promise.<ApiResult>
  • AddChat(params) ⇒ Promise.<ApiResult>
  • AddUserIntoChat(params) ⇒ Promise.<ApiResult>
  • AddOrRemoveUsersIntoChat(params) ⇒ Promise.<ApiResult>
  • ChangeName(params) ⇒ Promise.<ApiResult>
  • ChangeAvatar(formData) ⇒ Promise.<ApiResult>
  • UpdateTypeChat(params) ⇒ Promise.<ApiResult>
  • DeleteChat(params) ⇒ Promise.<ApiResult>
  • AddMessage(params) ⇒ Promise.<ApiResult>
  • DeleteMessage(params) ⇒ Promise.<ApiResult>
  • AddReaction(params) ⇒ Promise.<ApiResult>
  • RemoveReaction(params) ⇒ Promise.<ApiResult>

GetPaginatedWorkerChats(queryString) ⇒ Promise.<ApiResult>

Получает пагинированный список чатов текущего работника

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (пагинация, фильтры)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список чатов работника под полем pagination

---

GetChatsByUserId(queryString) ⇒ Promise.<ApiResult>

Получает список чатов текущего пользователя с фильтрацией по типу

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса с фильтром по типу

Возвращаемые данные

Returns: Promise.<ApiResult> - Список чатов пользователя

---

GetMessagesByChatId(queryString) ⇒ Promise.<ApiResult>

Получает список сообщений чата по его ID с пагинацией

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (ID чата, пагинация)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список сообщений чата под полем pagination

---

GetUnreadMessagesCount() ⇒ Promise.<ApiResult>

Получает количество непрочитанных сообщений для текущего пользователя

Возвращаемые данные

Returns: Promise.<ApiResult> - Количество непрочитанных сообщений

---

WriteMessageAndAddUserIntoOpenChat(params) ⇒ Promise.<ApiResult>

Отправляет сообщение и добавляет пользователя в открытый чат

Принимаемые параметры

Param	Type	Description
params	WriteMessageAndAddUserIntoOpenChatRequestParam	Параметры запроса с ID чата, ID пользователя и текстом сообщения

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

ClearUnreadMessageForUser(chatId) ⇒ Promise.<ApiResult>

Сбрасывает счётчик непрочитанных сообщений для текущего пользователя в указанном чате

Принимаемые параметры

Param	Type	Description
chatId	number	ID чата

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

GetChatById(params) ⇒ Promise.<ApiResult>

Получает чат с сообщениями по идентификатору

Принимаемые параметры

Param	Type	Description
params	Object	Параметры запроса
params.chatId	number	ID чата
params.take	number	Сколько последних сообщений вернуть

Возвращаемые данные

Returns: Promise.<ApiResult> - Чат с сообщениями

---

GetChatInfoById(chatId) ⇒ Promise.<ApiResult>

Получает данные чата без сообщений

Принимаемые параметры

Param	Type	Description
chatId	number	ID чата

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные чата

---

GetAlreadyCloseChatsWithUsers(groupId) ⇒ Promise.<ApiResult>

Получает уже закрытые чаты группы с их участниками

Принимаемые параметры

Param	Type	Description
groupId	number	ID группы

Возвращаемые данные

Returns: Promise.<ApiResult> - Список закрытых чатов

---

AddChat(params) ⇒ Promise.<ApiResult>

Создаёт чат

Принимаемые параметры

Param	Type	Description
params	AddChatRequestDto	Тело запроса. См. AddChatRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный чат

---

AddUserIntoChat(params) ⇒ Promise.<ApiResult>

Добавляет пользователя в чат по токену доступа

Принимаемые параметры

Param	Type	Description
params	AddUserIntoChatDto	Тело запроса. См. AddUserIntoChatDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

AddOrRemoveUsersIntoChat(params) ⇒ Promise.<ApiResult>

Добавляет и удаляет участников чата одним запросом

Принимаемые параметры

Param	Type	Description
params	AddOrRemoveUsersIntoChatRequestDto	Тело запроса. См. AddOrRemoveUsersIntoChatRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

ChangeName(params) ⇒ Promise.<ApiResult>

Меняет название чата

Принимаемые параметры

Param	Type	Description
params	ChangeChatNameRequestDto	Тело запроса. См. ChangeChatNameRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

ChangeAvatar(formData) ⇒ Promise.<ApiResult>

Меняет аватар чата

Принимаемые параметры

Param	Type	Description
formData	FormData	Multipart-форма с ID чата и файлом изображения

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

WARNING

Эндпоинт принимает multipart/form-data, поэтому здесь FormData с полями ChatId и Image.

---

UpdateTypeChat(params) ⇒ Promise.<ApiResult>

Меняет тип чата

Принимаемые параметры

Param	Type	Description
params	UpdateTypeChatRequestDto	Тело запроса. См. UpdateTypeChatRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

DeleteChat(params) ⇒ Promise.<ApiResult>

Удаляет чат

Принимаемые параметры

Param	Type	Description
params	DeleteChatRequestDto	Тело запроса. См. DeleteChatRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

INFO

Тело у DELETE-запроса: эндпоинт ждёт ID чата, группы и тип чата в теле, а не в пути.

---

AddMessage(params) ⇒ Promise.<ApiResult>

Отправляет сообщение в чат

Принимаемые параметры

Param	Type	Description
params	AddMessageRequestDto	Тело запроса. См. AddMessageRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданное сообщение

---

DeleteMessage(params) ⇒ Promise.<ApiResult>

Удаляет сообщение

Принимаемые параметры

Param	Type	Description
params	DeleteMessageRequestDto	Тело запроса. См. DeleteMessageRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

AddReaction(params) ⇒ Promise.<ApiResult>

Ставит реакцию на сообщение

Принимаемые параметры

Param	Type	Description
params	AddReactionRequestDto	Тело запроса. См. AddReactionRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Поставленная реакция

---

RemoveReaction(params) ⇒ Promise.<ApiResult>

Снимает реакцию с сообщения

Принимаемые параметры

Param	Type	Description
params	RemoveReactionRequestDto	Тело запроса. См. RemoveReactionRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---