Class Keyboard

Index

Constructors

Accessors

[toStringTag] NEGATIVE_COLOR POSITIVE_COLOR PRIMARY_COLOR SECONDARY_COLOR

Methods

applicationButton builder callbackButton keyboard locationRequestButton payButton textButton urlButton

Constructors

constructor

new Keyboard(): Keyboard
Returns Keyboard

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:18

`Static` NEGATIVE_COLOR

get NEGATIVE_COLOR(): NEGATIVE
The red button, indicates a dangerous or a negative action (reject, delete, etc...)

Hex color #E64646

Returns NEGATIVE
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:48

`Static` POSITIVE_COLOR

get POSITIVE_COLOR(): POSITIVE
The green button, indicates a agree, confirm, ...etc

Hex color #4BB34B

Returns POSITIVE
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:58

`Static` PRIMARY_COLOR

get PRIMARY_COLOR(): PRIMARY
The blue button, indicates the main action

Hex color #5181B8

Returns PRIMARY
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:38

`Static` SECONDARY_COLOR

get SECONDARY_COLOR(): SECONDARY
The white button, indicates secondary action

Hex color #FFFFFF

Returns SECONDARY
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:28

Methods

`Static` applicationButton

applicationButton(options): IKeyboardProxyButton
VK Apps button, occupies the entire keyboard width
Parameters
- options: IKeyboardApplicationButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:165

`Static` builder

builder(): KeyboardBuilder
Returns keyboard builder

Returns KeyboardBuilder
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:65

`Static` callbackButton

callbackButton(options): IKeyboardProxyButton
Allows without sending a message from the user to receive a notification of a button click and perform the necessary action
Parameters
- options: IKeyboardCallbackButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:175

`Static` keyboard

keyboard(rows): KeyboardBuilder
Assembles a builder of buttons
Parameters
- rows: (IKeyboardProxyButton | IKeyboardProxyButton[])[]
Returns KeyboardBuilder
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:72

`Static` locationRequestButton

locationRequestButton(options): IKeyboardProxyButton
User location request button, occupies the entire keyboard width
Parameters
- options: IKeyboardLocationRequestButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:147

`Static` payButton

payButton(options): IKeyboardProxyButton
VK Pay button, occupies the entire keyboard width
Parameters
- options: IKeyboardVKPayButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:156

`Static` textButton

textButton(options): IKeyboardProxyButton
Text button, can be colored
Parameters
- options: IKeyboardTextButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:129

`Static` urlButton

urlButton(options): IKeyboardProxyButton
URL button
Parameters
- options: IKeyboardURLButtonOptions
Returns IKeyboardProxyButton
- Defined in packages/vk-io/src/structures/keyboard/keyboard.ts:138

Generated using TypeDoc