Class BaseBotController<TUserData>

Бот контроллер по умолчанию. Стоит использовать в случаях, когда все команды добавляются через addCommand

Type Parameters

TUserData extends IUserData = IUserData

Hierarchy (View Summary)

BotController<TUserData>
- BaseBotController

Constructors

constructor

new BaseBotController<TUserData extends IUserData = IUserData>(): BaseBotController<
TUserData,
>
Protected
Создает новый экземпляр контроллера. Инициализирует все необходимые компоненты
Type Parameters
- TUserData extends IUserData = IUserData
Returns BaseBotController<TUserData>
Inherited from BotController.constructor
- Defined in src/controller/BotController.ts:597

Properties

appContext

appContext: AppContext

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

appeal

appeal: "official" | "no_official" | null = null

Стиль обращения к пользователю Определяет формальность общения

Remarks

Возможные значения:

'official': официальное обращение
'no_official': неофициальное обращение
null: стиль не определен

Example

this.appeal = 'official'; // официальное обращение

buttons

buttons: Buttons

Компонент для отображения кнопок пользователю. Позволяет создавать интерактивные элементы управления

See

Buttons

Example

this.buttons
  .addBtn('Помощь')
  .addBtn('Выход');

card

card: Card

Компонент для отображения карточек пользователю Позволяет создавать визуальные элементы с изображениями и текстом

See

Card

Example

this.card
  .addImage('url/to/image.jpg', 'Заголовок', 'Описание')

emotion

emotion: string | null = null

Эмоция для голосового ответа Используется для голосовых ассистентов

Example

this.emotion = 'good';

isAuth

isAuth: boolean = false

Флаг необходимости авторизации Определяет, требуется ли авторизация пользователя

Example

this.isAuth = true; // требуется авторизация

isEnd

isEnd: boolean = false

Флаг завершения сессии Определяет, нужно ли завершить диалог

Example

this.isEnd = true; // завершить диалог

isScreen

isScreen: boolean = false

Флаг наличия экрана Определяет, доступен ли экран пользователю

Example

this.isScreen = true; // экран доступен

isSend

isSend: boolean = false

Флаг необходимости отправки запроса к API Используется для Vk и Telegram

Remarks

Если true, все запросы уже отправлены в логике приложения

Example

this.isSend = true; // запросы уже отправлены

isSendRating

isSendRating: boolean = false

Флаг отправки запроса на оценку Определяет, нужно ли запросить оценку у пользователя

Example

this.isSendRating = true; // запросить оценку

messageId

messageId: string | number | null = null

ID сообщения Используется для определения начала нового диалога

Example

this.messageId = 12345;

nlu

nlu: Nlu

Обработанный NLU (Natural Language Understanding) Содержит результаты обработки естественного языка

See

Nlu

oldIntentName

oldIntentName: string | null = null

Название предыдущего интента. Используется для отслеживания контекста диалога

Example

this.oldIntentName = 'greeting';

originalUserCommand

originalUserCommand: string | null = null

Оригинальный запрос пользователя Текст запроса без изменений

Example

this.originalUserCommand = 'Привет, бот!';

payload

payload: string | object | null | undefined = null

Дополнительные параметры запроса Может содержать любые дополнительные данные

Example

this.payload = {
  source: 'mobile',
  version: '1.0'
};

requestObject

requestObject: string | object | null = null

Полученный запрос Содержит оригинальный объект запроса

Example

this.requestObject = {
  command: 'start',
  payload: { source: 'mobile' }
};

sound

sound: Sound

Компонент для работы со звуками. Позволяет добавлять звуковые эффекты и музыку

See

Sound

state

state: string | object | null = null

Пользовательское локальное хранилище Используется для Алисы, Маруси и Сбера

Example

this.state = {
  lastIntent: 'greeting',
  step: 1
};

store

store: Record<string, unknown> | undefined

Локальное хранилище с данными. Используется в случаях, когда нужно сохранить данные пользователя, но userData приложением не поддерживается. В случае если данные хранятся в usetData и store, пользователю вернятеся информация из userData.

text

text: string = ''

Текст, отображаемый пользователю Основной способ коммуникации с пользователем

Example

this.text = 'Привет! Чем могу помочь?';

thisIntentName

thisIntentName: string | null = null

Название текущего интента. Определяет текущее состояние диалога

Example

this.thisIntentName = 'help';

tts

tts: string | null = null

Текст для преобразования в речь. Используется для голосовых ассистентов

Remarks

Для неголосовых платформ текст будет преобразован в речь через Yandex SpeechKit и отправлен как аудио сообщение

Example

this.tts = 'Привет! Я голосовой ассистент.';

userCommand

userCommand: string | null = null

Запрос пользователя в нижнем регистре Нормализованный текст запроса

Example

this.userCommand = 'привет бот';

userData

userData: TUserData = ...

Пользовательские данные Хранятся в базе данных или файле

Remarks

Тип хранения зависит от параметра appContext.isSaveDb

Example

this.userData = {
  name: 'John',
  preferences: {
    language: 'ru'
  }
};

userEvents

userEvents: IUserEvent | null = null

Статус пользовательских событий Содержит информацию об авторизации и оценке

See

IUserEvent

Example

this.userEvents = {
  auth: { status: true },
  rating: { status: true, value: 5 }
};

userId

userId: string | number | null = null

Идентификатор пользователя Уникальный идентификатор для каждого пользователя

Example

this.userId = 'user_123';

userMeta

userMeta: any = null

Метаданные пользователя Дополнительная информация о пользователе

Example

this.userMeta = {
  timezone: 'Europe/Moscow',
  locale: 'ru-RU'
};

userToken

userToken: string | null = null

Пользовательский токен авторизации Используется для авторизованных запросов (например, в Алисе)

Example

this.userToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';

Methods

`Protected`_getCommand

_getCommand(): string | null
Protected
Получает команду из запроса пользователя Извлекает команду из текста запроса

Returns string | null
Команда или null
Example
```
const command = this._getCommand();
// 'start'
```
Inherited from BotController._getCommand
- Defined in src/controller/BotController.ts:714

`Protected`_getIntent

_getIntent(text: string | null): string | null
Protected
Определяет интент по тексту запроса. Сопоставляет текст с доступными интентами
Parameters
- text: string | null
  Текст запроса
Returns string | null
Название интента или null
Example
```
const intent = BotController._getIntent('привет');
// 'greeting'
```
Inherited from BotController._getIntent
- Defined in src/controller/BotController.ts:687

`Protected`_intents

_intents(): IAppIntent[]
Protected
Возвращает список доступных интентов. Определяет все возможные команды и их обработчики

Returns IAppIntent[]
Массив интентов
Example
```
const intents = BotController._intents();
// [
//   { name: 'greeting', slots: ['привет', 'здравствуйте'] },
//   { name: 'help', slots: ['помощь', 'справка'] }
// ]
```
Inherited from BotController._intents
- Defined in src/controller/BotController.ts:668

action

action(intentName: string | null, isCommand?: boolean): void
Обработка команд
Parameters
- intentName: string | null
- OptionalisCommand: boolean
Returns void
Overrides BotController.action
- Defined in src/controller/BaseBotController.ts:17

clearStoreData

clearStoreData(): void
Очищает все временные данные необходимы для отправки ответа.

Returns void
Inherited from BotController.clearStoreData
- Defined in src/controller/BotController.ts:623

run

run(): void
Запускает обработку запроса. Определяет тип запроса и вызывает соответствующий обработчик

Returns void
Example
```
this.run();
// Обрабатывает запрос и формирует ответ
```
Inherited from BotController.run
- Defined in src/controller/BotController.ts:793

setAppContext

setAppContext(appContext: AppContext): BotController
Устанавливает контекст приложения
Parameters
- appContext: AppContext
Returns BotController
Inherited from BotController.setAppContext
- Defined in src/controller/BotController.ts:610

Class BaseBotController<TUserData>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns BaseBotController<TUserData>

Properties

appContext

appeal

Remarks

Example

buttons

See

Example

card

See

Example

emotion

Example

isAuth

Example

isEnd

Example

isScreen

Example

isSend

Remarks

Example

isSendRating

Example

messageId

Example

nlu

See

oldIntentName

Example

originalUserCommand

Example

payload

Example

requestObject

Example

sound

See

state

Example

store

text

Example

thisIntentName

Example

tts

Remarks

Example

userCommand

Example

userData

Remarks

Example

userEvents

See

Example

userId

Example

userMeta

Example

userToken

Example

Methods

Protected_getCommand

Returns string | null

Example

Protected_getIntent

Parameters

Returns string | null

`Protected`_getCommand

`Protected`_getIntent

`Protected`_intents