umbot
    Preparing search index...

    Interface IPlatformOptions

    Дополнительные опции для платформ

    interface IPlatformOptions {
        apiVersion?: string | number;
        appId?: string;
        callbackNotificationText?: string;
        callbackQueryId?: string;
        chatId?: number;
        clientIp?: string;
        error?: string;
        eventId?: string;
        isState?: boolean;
        rateLimitOverflow?: boolean;
        requestData?: Record<string, Record<string, unknown>>;
        requestId?: string;
        sendInInit?: string | object | null;
        session?: object;
        stateName?: string;
        timeStart?: number;
        usedLocalStorage?: boolean;
    }
    Index

    Properties

    apiVersion? appId? callbackNotificationText? callbackQueryId? chatId? clientIp? error? eventId? isState? rateLimitOverflow? requestData? requestId? sendInInit? session? stateName? timeStart? usedLocalStorage?

    Properties

    apiVersion?: string | number

    Версия api с которой работает платформа. Для случаев, когда сама платформа говорит какая версия api должна быть

    appId?: string

    Идентификатор приложения

    callbackNotificationText?: string

    Явно заданный текст всплывающего уведомления для callback-запроса. Если поле не задано, адаптер только подтверждает callback без показа текста.

    callbackQueryId?: string

    ID callback-запроса

    chatId?: number

    ID чата для платформ, поддерживающих групповые чаты (например, Max, Telegram)

    clientIp?: string

    IP-адрес клиента, с которого пришёл webhook-запрос. Заполняется фреймворком автоматически в webhookHandle (из сокета HTTP-запроса) или в webhookEvent/run() при передаче параметром. Используется middleware ipFilter.

    error?: string

    Текст ошибки

    eventId?: string

    ID callback-события (для callback-кнопок)

    isState?: boolean

    Флаг, говорящий о том, что в приложении может использоваться локальное хранилище платформы

    rateLimitOverflow?: boolean

    Флаг, который выставляется middleware rateLimiter() перед выбросом исключения о переполнении очереди. Позволяет вызывающему коду (например, в responseCb) понять, что запрос отклонён по перегрузке, а не упал из-за ошибки в бизнес-логике.

    requestData?: Record<string, Record<string, unknown>>

    Нейтральные технические данные обработчика запроса.

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

    requestId?: string

    Уникальный идентификатор входящего запроса. Заполняется middleware requestId().

    sendInInit?: string | object | null

    Готовый shortcut-ответ платформы (строка или объект), который run() возвращает без обработки запроса. Заполняется адаптером в особых случаях (health-check «ping» у Алисы/Маруси, токен подтверждения webhook у VK); в формировании обычного ответа не участвует, если shortcut не нужен — остаётся null.

    session?: object

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

    stateName?: string

    Поле куда должны сохраниться пользовательские данные

    timeStart?: number

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

    usedLocalStorage?: boolean

    Флаг, говорящий о том, что приложение использует локальное хранилище платформы

    Settings

    Member Visibility

    On This Page

    Properties