Class BotControllerAbstract

Абстрактный класс, от которого наследуются все классы, обрабатывающие логику приложения.

Hierarchy

  • BotController

Constructors

constructor

Properties

appeal buttons card emotion isAuth isEnd isScreen isSend isSendRating messageId nlu oldIntentName originalUserCommand payload requestObject sound state text thisIntentName tts userCommand userData userEvents userId userMeta userToken

Methods

action run

Constructors

Protected constructor

Properties

appeal

appeal: null | "official" | "no_official"

Определяет манеру общения с пользователем. Общаемся на "Вы" или на "ты". Возможные значения: "official" - Официальный тон общения(на Вы) "no_official" - Общаемся на ты null - можно использовать любой тон Актуально для Сбер

Default Value

null

buttons

buttons: Buttons

Компонент, позволяющий отображать кнопки пользователю.

See

Buttons Смотри тут

card

card: Card

Компонент, позволяющий отображать карточки пользователю.

See

Card Смотри тут

emotion

emotion: null | string

Определяет эмоцию, с которой будет общаться приложение с пользователем. Актуально для Сбер.

isAuth

isAuth: boolean

Определяет необходимость запроса авторизации для пользователя (Актуально для Алисы).

isEnd

isEnd: boolean

Определяет состояние завершения сессии.

isScreen

isScreen: boolean

Определяет наличие экрана.

isSend

isSend: boolean

Определяет необходимость отправки запроса к api сервиса. Актуально для Vk и Telegram. Используется в случае, когда все запросы были отправлены в логике приложения, и дополнительных запросов делать не нужно.

isSendRating

isSendRating: boolean

Отправляет запрос на оценку приложения

Default Value

false

messageId

messageId: null | string | number

Id сообщения(Порядковый номер сообщения), необходимый для определения начала нового диалога с приложением.

nlu

nlu: Nlu

Обработанный nlu.

Link

nlu

See

Nlu Смотри тут

oldIntentName

oldIntentName: null | string

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

originalUserCommand

originalUserCommand: null | string

Оригинальный запрос пользователя.

payload

payload: undefined | null | string | object

Дополнительные параметры к запросу.

requestObject

requestObject: null | string | object

Полученный запрос.

sound

sound: Sound

Звуки, присутствующие в приложении.

See

Sound Смотри тут

state

state: null | string | object

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

text

text: string

Текст, отображаемый пользователю.

thisIntentName

thisIntentName: null | string

Идентификатор текущего действия пользователя. В случае, когда не нужно сохранять идентификатор предыдущей команды, необходимо значение установить в null

tts

tts: null | string

Текст, воспроизводимый пользователю. !Важно, если переменная заполняется для типов приложения отличных от голосовых ассистентов, то отправляется запрос в yandex speechkit для преобразования текста в речь. Полученный звук отправляется пользователю как аудио сообщение.

userCommand

userCommand: null | string

Запрос пользователя в нижнем регистре.

userData

userData: any

Пользовательские данные, хранящиеся в приложении. (Данный хранятся в базе данных либо в файле, тип зависит от параметра mmApp.isSaveDb).

userEvents

userEvents: null | IUserEvent

Определяет статус пользовательских событий, таких как успешная авторизация, либо оценка приложения.

userId

userId: null | string | number

Идентификатор пользователя.

userMeta

userMeta: any

Meta данные пользователя.

userToken

userToken: null | string

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

Methods

Abstract action

  • Обработка пользовательских команд.

    Если не удалось найти обрабатываемых команд в запросе, то в indentName придет null В таком случае стоит смотреть на предыдущую команду пользователя, либо вернуть текст помощи.

    Parameters

    • intentName: null | string

      Название действия.

    Returns void

run

Settings

Member Visibility

Theme

Generated using TypeDoc