Options
All
  • Public
  • Public/Protected
  • All
Menu

Класс отвечающий за тестирование приложения. В нем происходит инициализации параметров, выбор типа приложения, запуск логики и возврат корректного результата. Рекомендуется использовать его, для проверки своего приложения. При выпуске в релиз, стоит заменить на Bot

see

bot

Hierarchy

Index

Constructors

constructor

  • new BotTest(type?: "alisa" | "vk" | "telegram" | "viber" | "marusia" | "user_application" | "smart_app"): BotTest
  • Bot constructor.

    Parameters

    • Optional type: "alisa" | "vk" | "telegram" | "viber" | "marusia" | "user_application" | "smart_app"

    Returns BotTest

Properties

Protected _auth

_auth: null | string

Авторизационный токен если есть (Актуально для Алисы). Передастся в том случае, если пользователь произвел авторизацию в навыке.

Protected _botController

_botController: BotController

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

see

BotController Смотри тут

Protected _content

_content: TBotContent = null

Полученный запрос. В основном JSON или объект.

Methods

Protected getSkillContent

  • getSkillContent(query: string, count: number, state: string | object, userBotConfig?: null | Function): any
  • Возвращаем корректную конфигурацию для конкретного типа приложения.

    Parameters

    • query: string

      Пользовательский запрос.

    • count: number

      Номер сообщения.

    • state: string | object

      Данные из хранилища.

    • Optional userBotConfig: null | Function

      Функция, возвращающая параметры пользовательского приложения.

    Returns any

    any

initBotController

initConfig

  • Инициализация конфигурации приложения.

    api

    Parameters

    • config: IAppConfig

      Конфигурация приложения.

    Returns void

initParams

  • Инициализация параметров приложения.

    api

    Parameters

    • params: IAppParam

      Параметры приложения.

    Returns void

initTypeInGet

  • initTypeInGet(): boolean
  • Инициализация типа бота через GET параметры. Если присутствует get['type'], и он корректен (Равен одному из типов бота), тогда инициализация пройдет успешно.

    api

    Returns boolean

    boolean

run

  • Запуск приложения. В случае ошибки вернет исключение. Рекомендуется вызывать метод в том случае, когда используется свой webhook отличный от micro. При этому нужно самому заполнить данные в _content, а также обработать данные, переданные в заголовке.

    api
    see

    start

    see

    setContent

    Parameters

    • userBotClass: null | TemplateTypeModel = null

      Пользовательский класс для обработки команд.

    Returns Promise<TRunResult>

setContent

  • Устанавливает данные, полученные сервером. Не рекомендуется записывать данные самостоятельно. Стоит использовать тогда, когда запуск осуществляется через свой webhook. При этом данные не валидируется, и разработчик сам отвечает за переданный контент.

    Parameters

    • content: TBotContent

      Данные, полученные сервером.

    Returns void

start

  • start(req: IncomingMessage, res: ServerResponse, userBotClass?: null | TemplateTypeModel): Promise<void>
  • Запуск приложения через Webhook micro

    api

    Parameters

    • req: IncomingMessage

      Полученный запрос

    • res: ServerResponse

      Возврат запроса

    • userBotClass: null | TemplateTypeModel = null

      Пользовательский класс для обработки команд.

    Returns Promise<void>

test

  • Тестирование приложения. Отображает только ответы навыка. Никакой прочей информации (изображения, звуки, кнопки и тд) не отображаются!

    Для корректной работы, внутри логики навыка не должно быть пользовательских вызовов к серверу бота.

    api

    Parameters

    Returns Promise<void>

Generated using TypeDoc