Class Marusia

Класс для работы с платформой Маруся. Отвечает за инициализацию и обработку запросов от пользователя, а также формирование ответов в формате Маруси Marusia

See

TemplateTypeModel Смотри тут

Hierarchy (View Summary)

TemplateTypeModel
- Marusia

Constructors

constructor

new Marusia(appContext: AppContext): Marusia
Создает экземпляр класса. Инициализирует базовые параметры и время начала обработки
Parameters
- appContext: AppContext
Returns Marusia
Inherited from TemplateTypeModel.constructor
- Defined in src/platforms/TemplateTypeModel.ts:61

Properties

`Protected`_session

_session: IMarusiaSession | null = null

Информация о сессии пользователя

`Protected`_stateName

_stateName: "user_state_update" | "session_state" | null = null

Название хранилища данных Может быть одним из:

user_state_update: данные пользователя
session_state: данные сессии

`Protected`appContext

appContext: AppContext

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

`Protected`controller

controller: BotController

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

`Protected`error

error: string | null

Текст ошибки, возникшей при работе приложения

isUsedLocalStorage

isUsedLocalStorage: boolean

Флаг использования локального хранилища вместо БД. Используются стандартные механизмы хранения данных платформы

`Protected`MAX_TIME_REQUEST

MAX_TIME_REQUEST: number = 2900

Максимальное время ответа навыка в миллисекундах

sendInInit

sendInInit: any

Данные для немедленной отправки после инициализации. Если не null, команды пользователя не обрабатываются. Используется для проверки работоспособности приложения

`Protected`timeStart

timeStart: number | null

Время начала обработки запроса в миллисекундах

`Protected`WARMING_TIME_REQUEST

WARMING_TIME_REQUEST: number = 2000

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

Methods

`Protected`_getResponse

_getResponse(): Promise<IMarusiaResponse>
Protected
Формирует ответ для пользователя. Собирает текст, TTS, карточки и кнопки в единый объект ответа

Returns Promise<IMarusiaResponse>
Объект ответа для Маруси
- Defined in src/platforms/Marusia.ts:53

`Protected`_getSession

_getSession(): IMarusiaSessionResponse
Protected
Получает информацию о текущей сессии

Returns IMarusiaSessionResponse
Объект с данными сессии
- Defined in src/platforms/Marusia.ts:78

`Protected`_initTTS

_initTTS(appType: TAppType): Promise<void>
Protected
Инициализирует TTS (Text-to-Speech) в контроллере. Обрабатывает звуки и стандартные звуковые эффекты
Parameters
- appType: TAppType
  Тип приложения
Returns Promise<void>
Inherited from TemplateTypeModel._initTTS
- Defined in src/platforms/TemplateTypeModel.ts:78

`Protected`_timeLimitLog

_timeLimitLog(): void
Protected
При превышении установленного времени исполнения, пишет информацию в лог

Returns void
Inherited from TemplateTypeModel._timeLimitLog
- Defined in src/platforms/TemplateTypeModel.ts:126

getContext

getContext(): Promise<IMarusiaWebhookResponse>
Формирует полный ответ для отправки пользователю. Включает версию API, ответ навыка, данные сессии и состояние

Returns Promise<IMarusiaWebhookResponse>
Объект ответа для вебхука

See
TemplateTypeModel.getContext() Смотри тут
Overrides TemplateTypeModel.getContext
- Defined in src/platforms/Marusia.ts:188

getError

getError(): string | null
Получает текст ошибки, возникшей при выполнении программы

Returns string | null
Текст ошибки или null
Inherited from TemplateTypeModel.getError
- Defined in src/platforms/TemplateTypeModel.ts:118

getLocalStorage

getLocalStorage(): Promise<any>
Получение данные из локального хранилища Алисы

Returns Promise<any>
Overrides TemplateTypeModel.getLocalStorage
- Defined in src/platforms/Marusia.ts:206

getProcessingTime

getProcessingTime(): number
Получает время выполнения запроса в миллисекундах

Returns number
Время выполнения запроса
Inherited from TemplateTypeModel.getProcessingTime
- Defined in src/platforms/TemplateTypeModel.ts:110

getRatingContext

getRatingContext(): Promise<string | object>
Формирует ответ для оценки приложения По умолчанию вызывает getContext()

Returns Promise<string | object>
Ответ в формате платформы
Inherited from TemplateTypeModel.getRatingContext
- Defined in src/platforms/TemplateTypeModel.ts:158

init

init(
query: string | IMarusiaWebhookRequest,
controller: BotController,
): Promise<boolean>
Инициализирует основные параметры для работы с запросом
Parameters
- query: string | IMarusiaWebhookRequest
  Запрос пользователя в формате строки или объекта
- controller: BotController
  Контроллер с логикой навыка
Returns Promise<boolean>
true при успешной инициализации, false при ошибке

See
TemplateTypeModel.init() Смотри тут
Overrides TemplateTypeModel.init
- Defined in src/platforms/Marusia.ts:132

isLocalStorage

isLocalStorage(): boolean
Проверка на использование локального хранилища

Returns boolean
Overrides TemplateTypeModel.isLocalStorage
- Defined in src/platforms/Marusia.ts:214

setLocalStorage

setLocalStorage(data: any): Promise<void>
Сохраняет данные в локальное хранилище
Parameters
- data: any
  Данные для сохранения
Returns Promise<void>
Inherited from TemplateTypeModel.setLocalStorage
- Defined in src/platforms/TemplateTypeModel.ts:183

updateTimeStart

updateTimeStart(): void
Устанавливает время начала обработки запроса. Используется для измерения времени выполнения

Returns void
Inherited from TemplateTypeModel.updateTimeStart
- Defined in src/platforms/TemplateTypeModel.ts:102

Class Marusia

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Marusia

Properties

Protected_session

Protected_stateName

ProtectedappContext

Protectedcontroller

Protectederror

isUsedLocalStorage

ProtectedMAX_TIME_REQUEST

sendInInit

ProtectedtimeStart

ProtectedWARMING_TIME_REQUEST

Methods

Protected_getResponse

Returns Promise<IMarusiaResponse>

Protected_getSession

Returns IMarusiaSessionResponse

Protected_initTTS

Parameters

Returns Promise<void>

Protected_timeLimitLog

Returns void

getContext

Returns Promise<IMarusiaWebhookResponse>

See

getError

Returns string | null

getLocalStorage

Returns Promise<any>

getProcessingTime

Returns number

getRatingContext

Returns Promise<string | object>

init

Parameters

Returns Promise<boolean>

See

isLocalStorage

Returns boolean

setLocalStorage

Parameters

Returns Promise<void>

updateTimeStart

Returns void

Settings

On This Page

`Protected`_session

`Protected`_stateName

`Protected`appContext

`Protected`controller

`Protected`error

`Protected`MAX_TIME_REQUEST

`Protected`timeStart

`Protected`WARMING_TIME_REQUEST

`Protected`_getResponse

`Protected`_getSession

`Protected`_initTTS

`Protected`_timeLimitLog