Перейти к основному содержимому

Функции

Функции, доступные для выполнения в фрагментах кода и действии "Выполнить код"

setValue(key, value): void​

Устанавливает данные на основе ключа. Если ключа не существует, то он будет создан, в ином случае перезапишет данные ключа.

ПараметрТипОбязательныйОписание
keystringДаКлюч
valueanyДаЗначение
setValue('data.balance', 500)
setValue('data.name', 'Hello World!')
setValue('data', { balance: 500, name: 'Hello World!' })

getValue(key): Promise<any>​

Возвращает данные на основе указанного ключа.

ПараметрТипОбязательныйОписание
keystringДаКлюч значения
setValue('data', { balance: 500, name: 'Hello World!' })

let data = await getValue('data') // { balance: 500, name: 'Hello World!' }
let balance = await getValue('data.balance') // 500
let name = await getValue('data.name') // 'Hello World!'

deleteValue(key): void​

Удаляет данные на основе указанного ключа.

ПараметрТипОбязательныйОписание
keystringДаКлюч значения
setValue('data', { balance: 500, name: 'Hello World!' })

deleteValue('data.balance') // удалит только свойство balance
deleteValue('data')

createChannel(options): Promise<Channel>​

Создает новый канал на сервере.

ПараметрТипОбязательныйОписание
optionsCreateChannelOptionsДаОпции для канала

createThread(channelId, options): Promise<Thread>​

Создает новую ветку в канале.

ПараметрТипОбязательныйОписание
channelIdstringДаИдентификатор канала, в котором будет создана ветка
optionsCreateThreadOptionsДаОпции для ветки

deferReply(options): Promise<void>​

Откладывает ответ на команду.

ПараметрТипОбязательныйОписание
optionsDeferReplyOptionsНетОпции для ответа

deferUpdate(): Promise<void>​

Откладывает обновление сообщения, к которому был привязан компонент.

deleteChannel(channelId): Promise<void>​

Удаляет канал или ветку.

ПараметрТипОбязательныйОписание
channelIdstringДаИдентификатор канала, который нужно удалить

deleteMessage(channelId, messageId): Promise<void>​

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

ПараметрТипОбязательныйОписание
channelIdstringДаИдентификатор канала, в котором находится сообщение
messageIdstringДаИдентификатор сообщение, которое нужно удалить

deleteReply(): Promise<void>​

Удаляет ответ на команду.

editMessage(channelId, messageId, options): Promise<Message>​

Изменяет уже отправленное сообщение.

ПараметрТипОбязательныйОписание
channelIdstringДаИдентификатор канала, в котором находится сообщение
messageIdstringДаИдентификатор сообщение, которое нужно удалить
optionsMessageOptionsДаОпции для сообщения

editReply(options): Promise<void>​

Редактирует ответ на команду.

ПараметрТипОбязательныйОписание
optionsMessageOptionsДаОпции для ответа

followUpReply(options): Promise<void>​

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

ПараметрТипОбязательныйОписание
optionsReplyOptionsДаОпции для ответа

getUserActivity(userId): Promise<UserActivity>​

Получает активность пользователя.

ПараметрТипОбязательныйОписание
userIdstringДаИдентификатор пользователя

reply(options): Promise<void>​

Отправляет ответ на команду.

ПараметрТипОбязательныйОписание
optionsReplyOptionsДаОпции для ответа

showModal(options): Promise<void>​

Отображает модальный компонент

ПараметрТипОбязательныйОписание
optionsShowModalOptionsДаОпции модального окна

modifyUserRoles(userId, roles, mode): Promise<void>​

Редактирует роли пользователя.

ПараметрТипОбязательныйОписание
userIdstringДаИдентификатор пользователя, которому будут изменены роли
rolesarray of stringsДаРоли, которые будут добавлены/убраны/установлены
modestringНетРежим функции. add - добавить, remove - убрать, set - установить. По умолчанию - add

modifyUserWallet(userId, amount, currencyId): Promise<void>​

Добавляет/отнимает валюту у пользователя.

ПараметрТипОбязательныйОписание
userIdstringДаИдентификатор пользователя, которому будет изменен кошелёк
amountnumberДаКоличество валюты, которое будет добавлено или убрано. Негативное число отнимает валюту
currencyIdstringНетИдентификатор валюты. По умолчанию DEFAULT

sendMessage(channelId, options): Promise<Message>​

Отправляет сообщение в указанный канал.

ПараметрТипОбязательныйОписание
channelIdstringДаИдентификатор канала, в который будет отправлено сообщение
optionsMessageOptionsДаОпции для сообщения

overwriteChannelPermissions(channelIds, permissions, userOrRole): Promise<void>​

Переопределяет права выбранного канала для выбранного пользователя или роли.

ПараметрТипОбязательныйОписание
channelIdsarray of stringДаИдентификаторы каналов для которых будут переопределены права
permissionsPermissionsFlagsДаСписок прав, пример: {VIEW_CHANNEL: false}
userOrRolestringДаИдентификатор роли или пользователя