Class Buttons

Класс, хранящий в себе все кнопки приложения, а также отвечающий за отображение кнопок, в зависимости от типа приложения.

Hierarchy

  • Buttons

Constructors

constructor

Properties

btns buttons links type T_ALISA_BUTTONS T_ALISA_CARD_BUTTON T_SMARTAPP_BUTTONS T_SMARTAPP_BUTTON_CARD T_TELEGRAM_BUTTONS T_USER_APP_BUTTONS T_VIBER_BUTTONS T_VK_BUTTONS

Methods

_add _processing addBtn addLink clear getButtonJson getButtons

Constructors

constructor

Properties

btns

btns: TButton[]

Массив из кнопок вида кнопка.

  • string Текст, отображаемый на кнопке. or
  • object
    • string title Текст, отображаемый на кнопке.
    • string url Ссылка, по которой перейдет пользователь после нажатия на кнопку.
    • string payload Дополнительные параметры, передаваемые при нажатие на кнопку.

buttons

buttons: Button[]

Массив с различными кнопками.

See

Button Смотри тут

links

links: TButton[]

Массив из кнопок вида ссылка.

  • string Текст, отображаемый на кнопке. or
  • object
    • string title Текст, отображаемый на кнопке.
    • string url Ссылка, по которой перейдет пользователь после нажатия на кнопку.
    • string payload Дополнительные параметры, передаваемые при нажатие на кнопку.

type

type: string

Тип кнопок(кнопка в Алисе, кнопка в карточке Алисы, кнопка в Vk, кнопка в Telegram и тд).

Static Readonly T_ALISA_BUTTONS

T_ALISA_BUTTONS: "alisa_btn" = 'alisa_btn'

Кнопки для Алисы.

Static Readonly T_ALISA_CARD_BUTTON

T_ALISA_CARD_BUTTON: "alisa_card_btn" = 'alisa_card_btn'

Кнопки для карточки Алисе.

Static Readonly T_SMARTAPP_BUTTONS

T_SMARTAPP_BUTTONS: "smart-app_btn" = 'smart-app_btn'

Кнопки для Сбер SmartApp.

Static Readonly T_SMARTAPP_BUTTON_CARD

T_SMARTAPP_BUTTON_CARD: "smart-app_card_btn" = 'smart-app_card_btn'

Кнопки для карточки Сбер SmartApp.

Static Readonly T_TELEGRAM_BUTTONS

T_TELEGRAM_BUTTONS: "telegram_btn" = 'telegram_btn'

Кнопки для Telegram.

Static Readonly T_USER_APP_BUTTONS

T_USER_APP_BUTTONS: "user_app_btn" = 'user_app_btn'

Кнопки для пользовательского типа приложения.

Static Readonly T_VIBER_BUTTONS

T_VIBER_BUTTONS: "viber_btn" = 'viber_btn'

Кнопки для viber.

Static Readonly T_VK_BUTTONS

T_VK_BUTTONS: "vk_btn" = 'vk_btn'

Кнопки для vk.

Methods

Protected _add

  • _add(title: null | string, url: null | string, payload: any, hide?: boolean, options?: IButtonOptions): boolean

  • Добавление кнопки.

    Returns

    boolean

    Parameters

    • title: null | string

      Текст в кнопке.

    • url: null | string

      Ссылка для перехода при нажатии на кнопку.

    • payload: any

      Произвольные данные, отправляемые при нажатии на кнопку.

    • hide: boolean = false

      Определяет отображение кнопки как сайджест.

    • options: IButtonOptions = {}

      Дополнительные параметры кнопки

    Returns boolean

Protected _processing

  • _processing(): void

  • Дополнительная обработка второстепенных кнопок. А именно обрабатываются массивы btns и links. После чего все значения записываются в buttons.

    Returns void

addBtn

  • Добавить кнопку типа кнопка.

    Returns

    boolean

    Api

    Parameters

    • title: null | string

      Текст в кнопке.

    • url: null | string = ''

      Ссылка для перехода при нажатии на кнопку.

    • payload: any = ''

      Произвольные данные, отправляемые при нажатии на кнопку.

    • options: IButtonOptions = {}

      Дополнительные параметры кнопки

    Returns boolean

addLink

  • Добавить кнопку типа сайджест.

    Returns

    boolean

    Api

    Parameters

    • title: string

      Текст в кнопке.

    • url: string = ''

      Ссылка для перехода при нажатии на кнопку.

    • payload: any = ''

      Произвольные данные, отправляемые при нажатии на кнопку.

    • options: IButtonOptions = {}

      Дополнительные параметры кнопки

    Returns boolean

clear

getButtonJson

  • Возвращает json строку c кнопками.

    Returns

    string|null

    Api

    Parameters

    • type: null | string = null

      Тип приложения.

    • userButton: null | TemplateButtonTypes = null

      Класс с пользовательскими кнопками.

    Returns null | string

getButtons

  • Возвращает массив кнопок для ответа пользователю.

    Returns

    any

    Api

    Type Parameters

    • T = any

    Parameters

    • type: null | string = null

      Тип кнопки.

    • userButton: null | TemplateButtonTypes = null

      Класс с пользовательскими кнопками.

    Returns null | T

Settings

Member Visibility

Theme

Generated using TypeDoc