Методы API
В таблице приведено описание методов API, их аргументов и возвращаемых ими значений.
| Метод | Группа | Аргумент | Ответ | Описание |
|---|---|---|---|---|
| connect() | – | – | Promise<void> | Выполняет авторизацию |
| getSettings (settings) | _ | settings?: Array<SettingsName> | RestResponse<SettingsResponseData> | Возвращает значения настроек, имена которых были переданы в метод. Если не передавать имена, будут возвращены все настройки |
| getUserInfoByEmail (email) | _ | RestResponse<UserResponseData> | Возвращает информацию о пользователе на основе полученного адреса почты | |
| getRoomInfoByRoomId (rid, roomName) | _ | rid?: string; roomName?: string; | RestResponse<ChannelData> | Возвращает информацию о комнате на основе полученного идентификатора |
| sendMessageByRid (params) | message | params: SendMessageByRidParams | Promise<MessageResponseData> | Выполняет отправку сообщения по идентификатору комнаты |
| sendAttachment (params) | message | params: SendAttachmentSDKParams | Promise<MessageResponseData> | Выполняет отправку вложения по идентификатору комнаты |
| createDirectRoom (username) | room | username: string | Promise<DirectRoomResponseData | undefined> | Создает личную переписку с пользователем, имя которого было передано в качестве аргумента |
| addUsersToRoom (params) | room | params: AddUsersToRoomParams | RestResponse<boolean> | Добавляет пользователя в существующую комнату |
| removeUserFromChannel (params) | room | params: RemoveUserFromChannelParams | RestResponse<RemoveUserFromChannelResponseData> | Удаляет пользователя из комнаты, в которой этот пользователь состоит |
| createChannel (params) | room | params: CreateChannelSDKParams | RestResponse<ChannelData> | Создает комнату с переданными параметрами |
| setUserRole (params) | room | params: CreatePublicChannelSDKParams | CreatePrivateChannelSDKParams | RestResponse<CreatePublicChannelResponseData | CreatePrivateChannelResponseData> | Изменяет роль пользователя в комнате |
| saveRoomSettings (params) | room | params: SaveRoomSettingsSDKParams | RestResponse<SaveRoomSettingsData> | Изменяет настройки комнаты по ее идентификатору |
| onMessage (callback[, rid]) | subscription | callback: (msg: LastMessage) => void, rid?: string | Promise<OnMessagesResponse> | Вызывает переданную функцию с новым полученным сообщением в определенном чате rid или во всех |
| onRoomChange (rid, callback) | subscription | rid: string, callback: (data: RoomEvent) => void | Promise<OnRoomChangeResponse> | Вызывает переданную функцию с каждым событием в чате |
| onReaction (rid, msgId, callback) | subscription | rid: string, msgId: string, callback: (message: Message) => void | Promise<onReactionResponse> | Вызывает переданную функцию с сообщением при изменении его реакций |
| onEvent (callback) | subscription | callback: (data: WsData) => void | Subscription | Вызывает переданную функцию со всеми событиями, полученными по протоколу WebSocket |
| subscribe (collection, event) | subscription | collection: Collections, event: string | Promise<WsSubscription> | Позволяет произвольно подписаться на события, которые получены через onEvent |
| close() | subscription | – | Promise<void> | Закрывает соединение |
| reopen() | subscription | – | Promise<void> | Переоткрывает соединение |
| subscribeNotifyUser() | subscription | – | Promise<(WsSubscription)[]> | Осуществляет подписку на WebSocket-события, связанные с текущим пользователем |
| subscribeLoggedNotify() | subscription | – | Promise<(WsSubscription)[]> | Осуществляет подписку на WebSocket-события об изменениях авторизованных пользователей |
| subscribeNotifyAll() | subscription | – | Promise<(WsSubscription)[]> | Осуществляет подписку на общие для всех пользователей WebSocket-события |
| unsubscribe(id) | subscription | id: string | Promise<UnsubscribeResponseData> | Метод позволяет отписываться от WebSocket-событий по их id, который можно получить при подписке |
| getUserInfoByUsername (username) | – | username: string | RestResponse<UserResponseData> | Метод запрашивает информацию о пользователе по его имени |
| sendMessageToThread (params) | message | params: SendMessageToThreadSDKParams | Promise<MessageResponseData> | Отправляет сообщение в цепочку ответов |
| readThread (parentMessageId) | room | parentMessageId: string | Promise<void> | Помечает все сообщения внутри цепочки ответов с переданным parentMessageId как прочитанные |