Class SmartApp

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

See

TemplateTypeModel Смотри тут

Hierarchy (View Summary)

TemplateTypeModel
- SmartApp

Constructors

constructor

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

Properties

`Protected`_session

_session: ISberSmartAppSession | null = null

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

`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`_getPayload

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

Returns Promise<ISberSmartAppResponsePayload>
Объект ответа для SmartApp
- Defined in src/platforms/SmartApp.ts:37

`Protected`_getUserData

_getUserData(): Promise<unknown>
Protected
Получает данные пользователя из хранилища

Returns Promise<unknown>
Данные пользователя или строка с ошибкой
- Defined in src/platforms/SmartApp.ts:253

`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`_setUserData

_setUserData(data: any): Promise<IRequestSend<unknown>>
Protected
Сохраняет данные пользователя в хранилище
Parameters
- data: any
  Данные для сохранения
Returns Promise<IRequestSend<unknown>>
Результат сохранения
- Defined in src/platforms/SmartApp.ts:269

`Protected`_timeLimitLog

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

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

getContext

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

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

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

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/SmartApp.ts:289

getProcessingTime

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

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

getRatingContext

getRatingContext(): Promise<ISberSmartAppWebhookResponse>
Формирует ответ с оценкой навыка

Returns Promise<ISberSmartAppWebhookResponse>
Объект ответа для вебхука
Overrides TemplateTypeModel.getRatingContext
- Defined in src/platforms/SmartApp.ts:210

init

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

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

isLocalStorage

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

Returns boolean
true если используется локальное хранилище
Overrides TemplateTypeModel.isLocalStorage
- Defined in src/platforms/SmartApp.ts:297

setLocalStorage

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

updateTimeStart

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

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

Class SmartApp

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmartApp

Properties

Protected_session

ProtectedappContext

Protectedcontroller

Protectederror

isUsedLocalStorage

ProtectedMAX_TIME_REQUEST

sendInInit

ProtectedtimeStart

ProtectedWARMING_TIME_REQUEST

Methods

Protected_getPayload

Returns Promise<ISberSmartAppResponsePayload>

Protected_getUserData

Returns Promise<unknown>

Protected_initTTS

Parameters

Returns Promise<void>

Protected_setUserData

Parameters

Returns Promise<IRequestSend<unknown>>

Protected_timeLimitLog

Returns void

getContext

Returns Promise<ISberSmartAppWebhookResponse>

See

getError

Returns string | null

getLocalStorage

Returns Promise<any>

getProcessingTime

Returns number

getRatingContext

Returns Promise<ISberSmartAppWebhookResponse>

init

Parameters

Returns Promise<boolean>

See

isLocalStorage

Returns boolean

setLocalStorage

Parameters

Returns Promise<void>

updateTimeStart

Returns void

Settings

On This Page

`Protected`_session

`Protected`appContext

`Protected`controller

`Protected`error

`Protected`MAX_TIME_REQUEST

`Protected`timeStart

`Protected`WARMING_TIME_REQUEST

`Protected`_getPayload

`Protected`_getUserData

`Protected`_initTTS

`Protected`_setUserData

`Protected`_timeLimitLog