Class KeyboardBuilder

constructor

• new KeyboardBuilder(): KeyboardBuilder

• Returns KeyboardBuilder

isInline

isOneTime

[toStringTag]

• get [toStringTag](): string

• Returns custom tag

  Returns string

applicationButton

• applicationButton(__namedParameters): this

• VK Apps button, occupies the entire keyboard width

  builder.applicationButton({
   label: 'LiveWidget',
   appId: 6232540,
   ownerId: -157525928
  })
  Copy

  Parameters

  • __namedParameters: IKeyboardApplicationButtonOptions

  Returns this

callbackButton

• callbackButton(__namedParameters): this

• Allows without sending a message from the user to receive a notification of a button click and perform the necessary action

  builder.callbackButton({
   label: 'Buy a coffee',
   payload: {
    command: 'buy',
    item: 'coffee'
   }
  });
  Copy

  Parameters

  • __namedParameters: IKeyboardCallbackButtonOptions

  Returns this

clone

• clone(): KeyboardBuilder

• Clones the builder with all the settings

  Returns KeyboardBuilder

inline

• inline(enabled?): this

• Sets the keyboard inline

   builder.inline();
  
   builder.inline(false);
  Copy

  Parameters

  • enabled: boolean = true

  Returns this

locationRequestButton

• locationRequestButton(__namedParameters): this

• User location request button, occupies the entire keyboard width

  builder.locationRequestButton({
   payload: {
    command: 'order_delivery'
   }
  })
  Copy

  Parameters

  • __namedParameters: IKeyboardLocationRequestButtonOptions

  Returns this

oneTime

• oneTime(enabled?): this

• Sets the keyboard to close after pressing

   builder.oneTime();
  
   builder.oneTime(false);
  Copy

  Parameters

  • enabled: boolean = true

  Returns this

payButton

• payButton(__namedParameters): this

• VK Pay button, occupies the entire keyboard width

  builder.payButton({
   hash: {
    action: 'transfer-to-group',
    group_id: 1,
    aid: 10
   }
  })
  Copy

  Parameters

  • __namedParameters: IKeyboardVKPayButtonOptions

  Returns this

row

• row(): this

• Saves the current row of buttons in the general rows

  Returns this

textButton

• textButton(__namedParameters): this

• Text button, can be colored

  builder.textButton({
   label: 'Buy a coffee',
   payload: {
    command: 'buy',
    item: 'coffee'
   },
   color: Keyboard.POSITIVE_COLOR
  });
  Copy

  Parameters

  • __namedParameters: IKeyboardTextButtonOptions

  Returns this

toString

• toString(): string

• Returns a string to keyboard a VK

  Returns string

urlButton

• urlButton(__namedParameters): this

• URL button

  builder.urlButton({
   label: 'Buy a coffee',
   url: 'https://coffee.mania/buy'
  });
  Copy

  Parameters

  • __namedParameters: IKeyboardURLButtonOptions

  Returns this