Module "api/keyboard"

Index

Enumerations

Color

Classes

Keyboard

Interfaces

Type aliases

Button

Object literals

button

Type aliases

Button

Button: TextButton | LocationButton | VKPayButton | OpenAppButton

Object literals

Const button

button: object

location

location(payload?: Payload): LocationButton

- Defined in api/keyboard.ts:147
Creates a location-sending button.
example
```
button.location({a: 'b'})
```
Parameters
- Default value payload: Payload = ""
  
  button payload, see VK bots docs -> Section 4.3 for more details
Returns LocationButton

openApp

openApp(appId: number, ownerId?: number, label: string, hash: string): OpenAppButton

- Defined in api/keyboard.ts:196
Creates an app-opening button.
example
```
button.openApp(1, 1, 'My App', 'test')
```
Parameters
- appId: number
  
  Application ID
- Default value ownerId: number = null
  
  Group ID, if app needs to be opened in group context
- label: string
  
  Button label
- hash: string
  
  Parameters for app navigation
Returns OpenAppButton

text

text(label?: string, color?: Color, payload?: Payload): TextButton

- Defined in api/keyboard.ts:116
Creates a text-sending button.
example
```
button.text('Secondary');
button.text('Secondary', colors.secondary);
button.text('Secondary', colors.secondary, {a: 'b'});

button.text('Primary', colors.primary);
button.text('Negative', colors.negative);
button.text('Positive', colors.positive);
```
Parameters
- Default value label: string = "Button"
  
  button label
- Default value color: Color = Color.Secondary
  
  button color
- Default value payload: Payload = ""
  
  button payload, see VK bots docs -> Section 4.3 for more details
Returns TextButton

vkPay

vkPay(hash: string): VKPayButton

- Defined in api/keyboard.ts:172
Creates a VK Pay payment button.
example
```
button.vkPay('action=transfer-to-group&group_id=1&aid=10')
```
Parameters
- hash: string
  
  VK Pay parameters and app id in parameter aid, delimited by &, see VK Pay actions
Returns VKPayButton

Generated using TypeDoc