Class BasePlatformAdapter<TQuery>`Abstract`

Базовый адаптер для создания голосовых навыков и чат-ботов для собственной платформы (WeChat, WhatsApp, Slack и др.).

Чтобы подключить другую платформу, которая не поставляется из коробки, унаследуйтесь от класса и реализуйте все абстрактные методы. Адаптер автоматически зарегистрируется в системе при подключении через bot.use(new MyPlatformAdapter()).

=== Обязательные методы ===

isPlatformOnQuery — определяет, относится ли запрос к платформе или нет
setQueryData — обрабатывает запрос и заполняет controller данными
getContent — формирует ответ в формате платформы

=== Опциональные ===

getQueryExample — генерирует пример запроса необходимого для тестов
isLocalStorage, getLocalStorage, setLocalStorage — если платформа поддерживает сохранение локального состояния
soundProcessing — кастомная обработка TTS/звуков (для голосовых платформ, или отправка аудиофайла в боте).

See

Bot
BotController
BasePlatform

Type Parameters

TQuery = unknown

Hierarchy (View Summary)

BasePlugin
- BasePlatformAdapter

Implements

IPlatformAdapter<TQuery>

Constructors

constructor

new BasePlatformAdapter<TQuery = unknown>(
platformToken?: string,
additionalPlatformOptions?: IAdapterOptions,
): BasePlatformAdapter<TQuery>
Type Parameters
- TQuery = unknown
Parameters
- OptionalplatformToken: string
- OptionaladditionalPlatformOptions: IAdapterOptions
Returns BasePlatformAdapter<TQuery>
Overrides BasePlugin.constructor
- Defined in plugins/platforms/Base/Base.ts:94

Properties

`Protected` `Optional`_platformOptions

_platformOptions?: IAdapterOptions

`Protected` `Optional`_token

_token?: string

`Optional`appContext

appContext?: AppContext<unknown, TQuery>

Контекст приложения

isVoice

isVoice: boolean = true

Определяет тип платформы(голосовая или чат-бот)

limit

limit: number | null = null

Определяет лимит платформы. В значение указывается количество запросов, которое можно отправить платформе за 1 секунду. В случае если у платформы нет ограничений, можно указать 0 или null. По умолчанию null

`Protected`MAX_TIME_REQUEST

MAX_TIME_REQUEST: number = 2900

Максимальное время ответа навыка в миллисекундах при превышении этого времени, будет отправлена ошибка

platformName

platformName: string = 'unknown'

Имя платформы

`Optional`signatureName

signatureName?: string

Имя поля в заголовке запроса, по которому можно проверить корректность полученного запроса от платформы.

`Protected`WARMING_TIME_REQUEST

WARMING_TIME_REQUEST: number = 2000

Время ответа навыка в миллисекундах при превышении этого времени, будет отправлено предупреждение

Methods

`Protected`_initTTS

_initTTS(controller: BotController): void | Promise<void>
Protected
Инициализирует TTS (Text-to-Speech) в контроллере. Обрабатывает звуки и стандартные звуковые эффекты
Parameters
- controller: BotController
  Тип приложения
Returns void | Promise<void>
- Defined in plugins/platforms/Base/Base.ts:311

`Protected`_timeLimitLog

_timeLimitLog(controller: BotController): void
При превышении установленного времени исполнения, пишет информацию в лог После вызова getContent() автоматически проверяется время выполнения. Если оно превышает 2000 мс — пишется warning, если >2900 мс — ошибка.
Parameters
- controller: BotController
Returns void
- Defined in plugins/platforms/Base/Base.ts:285

destroy

destroy(_bot: Bot): void | Promise<void>
Метод, который вызывается при уничтожении плагина. В данном методе можно добавить отписку, либо выполнить другие действия.
Parameters
- _bot: Bot
  Основной класс приложения
Returns void | Promise<void>
Implementation of IPlatformAdapter.destroy
Inherited from BasePlugin.destroy
- Defined in plugins/Base.ts:21

`Abstract`getContent

getContent(
controller: BotController,
stateData?: Record<string, unknown> | null,
): TContent
Формирует тело ответа для отправки пользователю.

Возвращает платформо-специфичный ответ (например, JSON для Алисы). Для платформ, которые отправляют ответ напрямую (например, Telegram через sendMessage), метод может возвращать { ok: true } или аналог.
Parameters
- controller: BotController
  контроллер с готовым ответом
- OptionalstateData: Record<string, unknown> | null
  данные для локального хранилища
Returns TContent
ответ в формате, понятном платформе
Implementation of IPlatformAdapter.getContent
- Defined in plugins/platforms/Base/Base.ts:218

getLocalStorage

getLocalStorage<TStorageResult = unknown>(
_controller: BotController,
): TStorageResult | Promise<TStorageResult>
Получает данные из локального хранилища платформы.
Type Parameters
- TStorageResult = unknown
Parameters
- _controller: BotController
  контроллер приложения
Returns TStorageResult | Promise<TStorageResult>
данные, сохранённые ранее
Implementation of IPlatformAdapter.getLocalStorage
- Defined in plugins/platforms/Base/Base.ts:334

getProcessingTime

getProcessingTime(controller: BotController): number
Получает время выполнения запроса в миллисекундах
Parameters
- controller: BotController
Returns number
Время выполнения запроса
Implementation of IPlatformAdapter.getProcessingTime
- Defined in plugins/platforms/Base/Base.ts:276

getQueryExample

getQueryExample(
    query: string,
    userId: string,
    count: number,
    state: string | Record<string, unknown>,
): Record<string, unknown>
Генерирует пример входящего запроса для локального тестирования вашего приложения. Позволяет эмулировать запрос от платформы с заданным текстом, ID пользователя, номером сообщения и состоянием. Необходимо указывать для того, чтобы можно было корректно проверить работоспособность приложения.

Обязательно определите метод, если планируется тестирования приложения через инструменты предоставляемые платформой. Это существенно упростит процесс разработки приложения.
Parameters
- query: string
  Запрос пользователя
- userId: string
  Идентификатор пользователя
- count: number
  Порядковый номер запроса
- state: string | Record<string, unknown>
  Данные из локального хранилища
Returns Record<string, unknown>
Implementation of IPlatformAdapter.getQueryExample
- Defined in plugins/platforms/Base/Base.ts:122

getRatingContext

getRatingContext(controller: BotController): TContent
Формирует ответ с оценкой
Parameters
- controller: BotController
  контроллер приложения
Returns TContent
Implementation of IPlatformAdapter.getRatingContext
- Defined in plugins/platforms/Base/Base.ts:227

init

init(appContext: AppContext<IDatabaseInfo, TQuery>): void
Инициализация адаптера. Определять не обязательно. Стоит указывать в случаях, когда нужно выполнить доп логику, например указать токены или писать какую-то статистику по использованию.
Parameters
- appContext: AppContext<IDatabaseInfo, TQuery>
Returns void
Implementation of IPlatformAdapter.init
Overrides BasePlugin.init
- Defined in plugins/platforms/Base/Base.ts:105

isCorrectQuery

isCorrectQuery(query: TQuery, headers?: Record<string, unknown>): boolean
Проверяет полученный запрос от платформы на корректность. Из коробки проверка идет по sha256. Если по какой-то причине поведение по умолчанию не подходит, то просто переопределите метод.
Parameters
- query: TQuery
- Optionalheaders: Record<string, unknown>
Returns boolean
Implementation of IPlatformAdapter.isCorrectQuery
- Defined in plugins/platforms/Base/Base.ts:165

isLocalStorage

isLocalStorage(_controller: BotController): boolean
Указывает, поддерживает ли платформа локальное хранилище.
Parameters
- _controller: BotController
  контроллер приложения
Returns boolean
true, если локальное хранилище доступно
Implementation of IPlatformAdapter.isLocalStorage
- Defined in plugins/platforms/Base/Base.ts:324

`Abstract`isPlatformOnQuery

isPlatformOnQuery(query: TQuery, headers?: Record<string, unknown>): boolean
Возвращает признак того, соответствует ли запрос текущей платформе или нет
Parameters
- query: TQuery
  Запрос, который пришел в приложение
- Optionalheaders: Record<string, unknown>
  Заголовок с которым был отправлен запрос
Returns boolean
true, если запрос относится к этой платформе, иначе false
Example: Telegram
```
isPlatformOnQuery(query, headers) {
  return headers?.['x-telegram-bot-api-secret-token'] === this._token;
}
```
Example: Алиса (тело содержит "meta.session_id")
```
isPlatformOnQuery(query) {
  return typeof query === 'object' && query.meta?.session_id;
}
```
Implementation of IPlatformAdapter.isPlatformOnQuery
- Defined in plugins/platforms/Base/Base.ts:157

send

send(
userId: string | number,
controllerOrText: string | BotController<IUserData, IPlatformData>,
): boolean | TContent
Отправка текста пользователю Этот метод используется для активных рассылок — когда голосовой навык или чат-бот инициирует диалог первым (например, уведомление). В методе реализована механика преобразования текстового значения controllerOrText в контроллер, а также базовый механизм для отправки ответа.

Переопределять данный метод не рекомендуется. Переопределить стоит только в том случае, если по каким-то технических условиям текущая реализация метода вам не подходит.

Если платформа не поддерживает возможность начать диалог самостоятельно, то можно оставить метод пустым, либо вывести любую заглушку.
Parameters
- userId: string | number
  Ид пользователя, которому нужно отправить сообщение
- controllerOrText: string | BotController<IUserData, IPlatformData>
  Контроллер приложения или текст. Если необходимо отправить просто текст, можно передать строку, в случае, если необходимо передать картинку звук и тд, то необходимо корректно заполнить контроллер.
Returns boolean | TContent
Implementation of IPlatformAdapter.send
- Defined in plugins/platforms/Base/Base.ts:242

setLocalStorage

setLocalStorage<TStorageData>(
_data: TStorageData,
_controller: BotController,
): void | Promise<void>
Сохраняет данные в локальное хранилище платформы.
Type Parameters
- TStorageData
Parameters
- _data: TStorageData
  данные для сохранения
- _controller: BotController
  контроллер приложения
Returns void | Promise<void>
Implementation of IPlatformAdapter.setLocalStorage
- Defined in plugins/platforms/Base/Base.ts:346

`Abstract`setQueryData

setQueryData(
query: TQuery,
controller: BotController,
): boolean | Promise<boolean>
Обрабатывает входящий запрос и заполняет контроллер данными.

Обязательно установите:
- controller.userCommand и controller.originalUserCommand — текст сообщения пользователя
- controller.userId — уникальный ID пользователя
- controller.appType = this.platformName
Опционально:
- controller.userToken — если платформа присылает токен авторизации
- controller.userMeta — если платформа присылает метаданные
- controller.state — если платформа поддерживает локальное хранилище
- controller.nlu — если платформа присылает NLU/интенты (через controller.nlu.setNlu(...))
Parameters
- query: TQuery
  Запрос от платформы
- controller: BotController
  Контроллер приложения
Returns boolean | Promise<boolean>
false, если запрос повреждён или не может быть обработан; иначе true
Implementation of IPlatformAdapter.setQueryData
- Defined in plugins/platforms/Base/Base.ts:205

soundProcessing

soundProcessing(_controller: BotController): void | Promise<void>
Дополнительная обработка для звуков. В данном методе стоит реализовать логику, с помощью которой будут наложены дополнительные эффекты для озвучивания текста пользователю
Parameters
- _controller: BotController
Returns void | Promise<void>
- Defined in plugins/platforms/Base/Base.ts:301

updateTimeStart

updateTimeStart(controller: BotController): void
Устанавливает время начала обработки запроса. Используется для измерения времени выполнения
Parameters
- controller: BotController
Returns void
Implementation of IPlatformAdapter.updateTimeStart
- Defined in plugins/platforms/Base/Base.ts:268

`Static`isVoice

isVoice(): boolean
Флаг, указывающий, что платформа голосовая (например, Алиса, Маруся).

Returns boolean
- Defined in plugins/platforms/Base/Base.ts:356

Class BasePlatformAdapter<TQuery>Abstract

See

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BasePlatformAdapter<TQuery>

Properties

Protected Optional_platformOptions

Protected Optional_token

OptionalappContext

isVoice

limit

ProtectedMAX_TIME_REQUEST

platformName

OptionalsignatureName

ProtectedWARMING_TIME_REQUEST

Methods

Protected_initTTS

Parameters

Returns void | Promise<void>

Protected_timeLimitLog

Parameters

Returns void

destroy

Parameters

Returns void | Promise<void>

AbstractgetContent

Parameters

Returns TContent

getLocalStorage

Type Parameters

Parameters

Returns TStorageResult | Promise<TStorageResult>

getProcessingTime

Parameters

Returns number

getQueryExample

Parameters

Returns Record<string, unknown>

getRatingContext

Parameters

Returns TContent

init

Parameters

Returns void

isCorrectQuery

Parameters

Returns boolean

isLocalStorage

Parameters

Returns boolean

AbstractisPlatformOnQuery

Parameters

Returns boolean

Example: Telegram

Example: Алиса (тело содержит "meta.session_id")

send

Parameters

Returns boolean | TContent

setLocalStorage

Type Parameters

Parameters

Returns void | Promise<void>

AbstractsetQueryData

Parameters

Returns boolean | Promise<boolean>

soundProcessing

Parameters

Returns void | Promise<void>

updateTimeStart

Parameters

Returns void

Class BasePlatformAdapter<TQuery>`Abstract`

`Protected` `Optional`_platformOptions

`Protected` `Optional`_token

`Optional`appContext

`Protected`MAX_TIME_REQUEST

`Optional`signatureName

`Protected`WARMING_TIME_REQUEST

`Protected`_initTTS

`Protected`_timeLimitLog

`Abstract`getContent

`Abstract`isPlatformOnQuery

`Abstract`setQueryData

`Static`isVoice