Class Marusia

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

See

TemplateTypeModel Смотри тут

Hierarchy (View Summary)

TemplateTypeModel
- Marusia

Index

Constructors

constructor

new Marusia(): Marusia
Создает экземпляр класса Инициализирует базовые параметры и время начала обработки

Returns Marusia
Inherited from TemplateTypeModel.constructor
- Defined in src/platforms/TemplateTypeModel.ts:47

Properties

`Protected`_session

_session: null | IMarusiaSession = null

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

`Protected`_stateName

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

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

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

`Protected`error

error: null | string

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

`Protected`timeStart

timeStart: null | number

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

`Protected`controller

controller: BotController

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

isUsedLocalStorage

isUsedLocalStorage: boolean

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

sendInInit

sendInInit: any

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

Methods

`Protected`_getResponse

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

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

`Protected`_getSession

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

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

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:141

getContext

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

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

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

getLocalStorage

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

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

isLocalStorage

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

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

`Protected`_initTTS

_initTTS(): Promise<void>
Protected
Инициализирует TTS (Text-to-Speech) в контроллере Обрабатывает звуки и стандартные звуковые эффекты

Returns Promise<void>
Inherited from TemplateTypeModel._initTTS
- Defined in src/platforms/TemplateTypeModel.ts:62

getProcessingTime

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

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

getError

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

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

getRatingContext

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

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

setLocalStorage

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

Class Marusia

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Marusia

Properties

Protected_session

Protected_stateName

Protectederror

ProtectedtimeStart

Protectedcontroller

isUsedLocalStorage

sendInInit

Methods

Protected_getResponse

Returns Promise<IMarusiaResponse>

Protected_getSession

Returns IMarusiaSessionResponse

init

Parameters

Returns Promise<boolean>

See

getContext

Returns Promise<IMarusiaWebhookResponse>

See

getLocalStorage

Returns Promise<any>

isLocalStorage

Returns boolean

Protected_initTTS

Returns Promise<void>

getProcessingTime

Returns number

getError

Returns null | string

getRatingContext

Returns Promise<string | object>

setLocalStorage

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`_session

`Protected`_stateName

`Protected`error

`Protected`timeStart

`Protected`controller

`Protected`_getResponse

`Protected`_getSession

`Protected`_initTTS