Class BotTest

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

See

bot

Hierarchy

Constructors

constructor

Properties

_auth _botController _content serverInst

Methods

close getSkillContent initBotController initConfig initParams initTypeInGet run setContent start startOld test

Constructors

constructor

Properties

Protected _auth

_auth: TBotAuth

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

Protected _botController

_botController: BotController

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

See

BotController Смотри тут

Protected _content

_content: TBotContent = null

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

serverInst

serverInst: undefined | Server

Methods

close

Protected getSkillContent

  • Возвращаем корректную конфигурацию для конкретного типа приложения.

    Returns

    any

    Parameters

    • query: string

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

    • count: number

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

    • state: string | object

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

    • Optional userBotConfig: null | Function

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

    Returns any

initBotController

initConfig

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

    Api

    Parameters

    • config: IAppConfig

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

    Returns void

initParams

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

    Api

    Parameters

    • params: IAppParam

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

    Returns void

initTypeInGet

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

    Returns

    boolean

    Api

    Returns boolean

run

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

    Returns

    Api

    See

    • start
    • setContent

    Parameters

    • userBotClass: null | TemplateTypeModel = null

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

    Returns Promise<TRunResult>

setContent

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

    Parameters

    • content: TBotContent

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

    Returns void

start

  • Запуск приложения через http

    Returns

    Api

    Parameters

    • hostname: string

      Имя хоста, на котором будет запущено приложение

    • port: number

      Порт, на котором будет запущено приложение

    • userBotClass: null | TemplateTypeModel = null

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

    Returns void

startOld

  • Запуск приложения через micro. Не рекомендуется к использованию, и в ближайщих обновлениях будет удалено. Оставлено для совместимости.

    Returns

    Api

    Parameters

    • req: IncomingMessage

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

    • res: ServerResponse

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

    • userBotClass: null | TemplateTypeModel = null

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

    Returns Promise<void>

test

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

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

    Returns

    Api

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc