Class Telegram

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

See

TemplateTypeModel Смотри тут

Hierarchy (View Summary)

TemplateTypeModel
- Telegram

Constructors

constructor

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

Properties

`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`_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<string>
Формирует и отправляет ответ пользователю. Отправляет текст, карточки, опросы и звуки через Telegram API

Returns Promise<string>
'ok' при успешной отправке

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

getError

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

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

getLocalStorage

getLocalStorage(): Promise<string | object | null>
Получает данные из локального хранилища

Returns Promise<string | object | null>
Данные из хранилища или null
Inherited from TemplateTypeModel.getLocalStorage
- Defined in src/platforms/TemplateTypeModel.ts:174

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 | ITelegramContent,
controller: BotController,
): Promise<boolean>
Инициализирует основные параметры для работы с запросом. Обрабатывает входящие сообщения и обновления от Telegram
Parameters
- query: string | ITelegramContent
  Запрос пользователя в формате строки или объекта
- controller: BotController
  Контроллер с логикой бота
Returns Promise<boolean>
true при успешной инициализации, false при ошибке
See
- TemplateTypeModel.init() Смотри тут
Поддерживаемые типы обновлений:
- message: новое входящее сообщение
- edited_message: отредактированное сообщение
- channel_post: новый пост в канале
- edited_channel_post: отредактированный пост в канале
- inline_query: встроенный запрос
- callback_query: запрос обратного вызова
- shipping_query: запрос на доставку
- pre_checkout_query: запрос предварительной проверки
- poll: состояние опроса
- poll_answer: ответ в опросе
- https://core.telegram.org/bots/api#getting-updates Документация по обновлениям
Overrides TemplateTypeModel.init
- Defined in src/platforms/Telegram.ts:40

isLocalStorage

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

Returns boolean
true если хранилище доступно и используется
Inherited from TemplateTypeModel.isLocalStorage
- Defined in src/platforms/TemplateTypeModel.ts:166

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 Telegram

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Telegram

Properties

ProtectedappContext

Protectedcontroller

Protectederror

isUsedLocalStorage

ProtectedMAX_TIME_REQUEST

sendInInit

ProtectedtimeStart

ProtectedWARMING_TIME_REQUEST

Methods

Protected_initTTS

Parameters

Returns Promise<void>

Protected_timeLimitLog

Returns void

getContext

Returns Promise<string>

See

getError

Returns string | null

getLocalStorage

Returns Promise<string | object | null>

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

`Protected`controller

`Protected`error

`Protected`MAX_TIME_REQUEST

`Protected`timeStart

`Protected`WARMING_TIME_REQUEST

`Protected`_initTTS

`Protected`_timeLimitLog