1
+ <!doctype html>
2
+ < html class ="default no-js ">
3
+ < head >
4
+ < meta charset ="utf-8 ">
5
+ < meta http-equiv ="X-UA-Compatible " content ="IE=edge ">
6
+ < title > Keyboard | vk-chat-bot</ title >
7
+ < meta name ="description " content ="Documentation for vk-chat-bot ">
8
+ < meta name ="viewport " content ="width=device-width, initial-scale=1 ">
9
+ < link rel ="stylesheet " href ="../assets/css/main.css ">
10
+ </ head >
11
+ < body >
12
+ < header >
13
+ < div class ="tsd-page-toolbar ">
14
+ < div class ="container ">
15
+ < div class ="table-wrap ">
16
+ < div class ="table-cell " id ="tsd-search " data-index ="../assets/js/search.json " data-base =".. ">
17
+ < div class ="field ">
18
+ < label for ="tsd-search-field " class ="tsd-widget search no-caption "> Search</ label >
19
+ < input id ="tsd-search-field " type ="text " />
20
+ </ div >
21
+ < ul class ="results ">
22
+ < li class ="state loading "> Preparing search index...</ li >
23
+ < li class ="state failure "> The search index is not available</ li >
24
+ </ ul >
25
+ < a href ="../index.html " class ="title "> vk-chat-bot</ a >
26
+ </ div >
27
+ < div class ="table-cell " id ="tsd-widgets ">
28
+ < div id ="tsd-filter ">
29
+ < a href ="# " class ="tsd-widget options no-caption " data-toggle ="options "> Options</ a >
30
+ < div class ="tsd-filter-group ">
31
+ < div class ="tsd-select " id ="tsd-filter-visibility ">
32
+ < span class ="tsd-select-label "> All</ span >
33
+ < ul class ="tsd-select-list ">
34
+ < li data-value ="public "> Public</ li >
35
+ < li data-value ="protected "> Public/Protected</ li >
36
+ < li data-value ="private " class ="selected "> All</ li >
37
+ </ ul >
38
+ </ div >
39
+ < input type ="checkbox " id ="tsd-filter-inherited " checked />
40
+ < label class ="tsd-widget " for ="tsd-filter-inherited "> Inherited</ label >
41
+ < input type ="checkbox " id ="tsd-filter-externals " checked />
42
+ < label class ="tsd-widget " for ="tsd-filter-externals "> Externals</ label >
43
+ < input type ="checkbox " id ="tsd-filter-only-exported " />
44
+ < label class ="tsd-widget " for ="tsd-filter-only-exported "> Only exported</ label >
45
+ </ div >
46
+ </ div >
47
+ < a href ="# " class ="tsd-widget menu no-caption " data-toggle ="menu "> Menu</ a >
48
+ </ div >
49
+ </ div >
50
+ </ div >
51
+ </ div >
52
+ < div class ="tsd-page-title ">
53
+ < div class ="container ">
54
+ < ul class ="tsd-breadcrumb ">
55
+ < li >
56
+ < a href ="../globals.html "> Globals</ a >
57
+ </ li >
58
+ < li >
59
+ < a href ="../modules/_api_keyboard_.html "> "api/keyboard"</ a >
60
+ </ li >
61
+ < li >
62
+ < a href ="_api_keyboard_.keyboard.html "> Keyboard</ a >
63
+ </ li >
64
+ </ ul >
65
+ < h1 > Class Keyboard</ h1 >
66
+ </ div >
67
+ </ div >
68
+ </ header >
69
+ < div class ="container container-main ">
70
+ < div class ="row ">
71
+ < div class ="col-8 col-content ">
72
+ < section class ="tsd-panel tsd-comment ">
73
+ < div class ="tsd-comment tsd-typography ">
74
+ < div class ="lead ">
75
+ < p > See full keyboard example in < a href ="_api_context_.context.html#keyboard "> Context.keyboard</ a > .</ p >
76
+ </ div >
77
+ </ div >
78
+ </ section >
79
+ < section class ="tsd-panel tsd-hierarchy ">
80
+ < h3 > Hierarchy</ h3 >
81
+ < ul class ="tsd-hierarchy ">
82
+ < li >
83
+ < span class ="target "> Keyboard</ span >
84
+ </ li >
85
+ </ ul >
86
+ </ section >
87
+ < section class ="tsd-panel-group tsd-index-group ">
88
+ < h2 > Index</ h2 >
89
+ < section class ="tsd-panel tsd-index-panel ">
90
+ < div class ="tsd-index-content ">
91
+ < section class ="tsd-index-section ">
92
+ < h3 > Constructors</ h3 >
93
+ < ul class ="tsd-index-list ">
94
+ < li class ="tsd-kind-constructor tsd-parent-kind-class "> < a href ="_api_keyboard_.keyboard.html#constructor " class ="tsd-kind-icon "> constructor</ a > </ li >
95
+ </ ul >
96
+ </ section >
97
+ < section class ="tsd-index-section ">
98
+ < h3 > Properties</ h3 >
99
+ < ul class ="tsd-index-list ">
100
+ < li class ="tsd-kind-property tsd-parent-kind-class "> < a href ="_api_keyboard_.keyboard.html#buttons " class ="tsd-kind-icon "> buttons</ a > </ li >
101
+ < li class ="tsd-kind-property tsd-parent-kind-class "> < a href ="_api_keyboard_.keyboard.html#one_time " class ="tsd-kind-icon "> one_< wbr > time</ a > </ li >
102
+ </ ul >
103
+ </ section >
104
+ </ div >
105
+ </ section >
106
+ </ section >
107
+ < section class ="tsd-panel-group tsd-member-group ">
108
+ < h2 > Constructors</ h2 >
109
+ < section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class ">
110
+ < a name ="constructor " class ="tsd-anchor "> </ a >
111
+ < h3 > constructor</ h3 >
112
+ < ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class ">
113
+ < li class ="tsd-signature tsd-kind-icon "> new < wbr > Keyboard< span class ="tsd-signature-symbol "> (</ span > buttons< span class ="tsd-signature-symbol "> ?: </ span > < a href ="../modules/_api_keyboard_.html#button " class ="tsd-signature-type "> Button</ a > < span class ="tsd-signature-symbol "> []</ span > < span class ="tsd-signature-symbol "> []</ span > , oneTime< span class ="tsd-signature-symbol "> ?: </ span > < span class ="tsd-signature-type "> boolean</ span > < span class ="tsd-signature-symbol "> )</ span > < span class ="tsd-signature-symbol "> : </ span > < a href ="_api_keyboard_.keyboard.html " class ="tsd-signature-type "> Keyboard</ a > </ li >
114
+ </ ul >
115
+ < ul class ="tsd-descriptions ">
116
+ < li class ="tsd-description ">
117
+ < aside class ="tsd-sources ">
118
+ < ul >
119
+ < li > Defined in < a href ="https://github.com/u32i64/vk-chat-bot/blob/6caaf9c/src/api/keyboard.ts#L16 "> api/keyboard.ts:16</ a > </ li >
120
+ </ ul >
121
+ </ aside >
122
+ < div class ="tsd-comment tsd-typography ">
123
+ < div class ="lead ">
124
+ < p > Creates a new < a href ="_api_keyboard_.keyboard.html "> Keyboard</ a > .</ p >
125
+ </ div >
126
+ < dl class ="tsd-comment-tags ">
127
+ < dt > example</ dt >
128
+ < dd > < pre > < code > < span class ="hljs-keyword "> var</ span > kbd = < span class ="hljs-keyword "> new</ span > < span class ="hljs-type "> Keyboard</ span > ([
129
+ < span class ="hljs-comment "> // One row</ span >
130
+ [
131
+ button.text(< span class ="hljs-string "> 'Maximum rows is 10, columns - 4.'</ span > )
132
+ ],
133
+ ]);</ code > </ pre > </ dd >
134
+ </ dl >
135
+ </ div >
136
+ < h4 class ="tsd-parameters-title "> Parameters</ h4 >
137
+ < ul class ="tsd-parameters ">
138
+ < li >
139
+ < h5 > < span class ="tsd-flag ts-flagDefault value "> Default value</ span > buttons: < a href ="../modules/_api_keyboard_.html#button " class ="tsd-signature-type "> Button</ a > < span class ="tsd-signature-symbol "> []</ span > < span class ="tsd-signature-symbol "> []</ span > < span class ="tsd-signature-symbol "> = []</ span > </ h5 >
140
+ < div class ="tsd-comment tsd-typography ">
141
+ < div class ="lead ">
142
+ < p > array of arrays (rows) of buttons</ p >
143
+ </ div >
144
+ </ div >
145
+ </ li >
146
+ < li >
147
+ < h5 > < span class ="tsd-flag ts-flagDefault value "> Default value</ span > oneTime: < span class ="tsd-signature-type "> boolean</ span > < span class ="tsd-signature-symbol "> = false</ span > </ h5 >
148
+ < div class ="tsd-comment tsd-typography ">
149
+ < div class ="lead ">
150
+ < p > show only once? (or disappear after button press?)</ p >
151
+ </ div >
152
+ </ div >
153
+ </ li >
154
+ </ ul >
155
+ < h4 class ="tsd-returns-title "> Returns < a href ="_api_keyboard_.keyboard.html " class ="tsd-signature-type "> Keyboard</ a > </ h4 >
156
+ </ li >
157
+ </ ul >
158
+ </ section >
159
+ </ section >
160
+ < section class ="tsd-panel-group tsd-member-group ">
161
+ < h2 > Properties</ h2 >
162
+ < section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class ">
163
+ < a name ="buttons " class ="tsd-anchor "> </ a >
164
+ < h3 > < span class ="tsd-flag ts-flagReadonly "> Readonly</ span > buttons</ h3 >
165
+ < div class ="tsd-signature tsd-kind-icon "> buttons< span class ="tsd-signature-symbol "> :</ span > < a href ="../modules/_api_keyboard_.html#button " class ="tsd-signature-type "> Button</ a > < span class ="tsd-signature-symbol "> []</ span > < span class ="tsd-signature-symbol "> []</ span > </ div >
166
+ < aside class ="tsd-sources ">
167
+ < ul >
168
+ < li > Defined in < a href ="https://github.com/u32i64/vk-chat-bot/blob/6caaf9c/src/api/keyboard.ts#L16 "> api/keyboard.ts:16</ a > </ li >
169
+ </ ul >
170
+ </ aside >
171
+ < div class ="tsd-comment tsd-typography ">
172
+ < div class ="lead ">
173
+ < p > Items of this keyboard.</ p >
174
+ </ div >
175
+ </ div >
176
+ </ section >
177
+ < section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class ">
178
+ < a name ="one_time " class ="tsd-anchor "> </ a >
179
+ < h3 > < span class ="tsd-flag ts-flagReadonly "> Readonly</ span > one_< wbr > time</ h3 >
180
+ < div class ="tsd-signature tsd-kind-icon "> one_< wbr > time< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> boolean</ span > </ div >
181
+ < aside class ="tsd-sources ">
182
+ < ul >
183
+ < li > Defined in < a href ="https://github.com/u32i64/vk-chat-bot/blob/6caaf9c/src/api/keyboard.ts#L11 "> api/keyboard.ts:11</ a > </ li >
184
+ </ ul >
185
+ </ aside >
186
+ < div class ="tsd-comment tsd-typography ">
187
+ < div class ="lead ">
188
+ < p > Is this keyboard one-time?</ p >
189
+ </ div >
190
+ </ div >
191
+ </ section >
192
+ </ section >
193
+ </ div >
194
+ < div class ="col-4 col-menu menu-sticky-wrap menu-highlight ">
195
+ < nav class ="tsd-navigation primary ">
196
+ < ul >
197
+ < li class ="globals ">
198
+ < a href ="../globals.html "> < em > Globals</ em > </ a >
199
+ </ li >
200
+ < li class =" tsd-kind-module ">
201
+ < a href ="../modules/_api_api_.html "> "api/api"</ a >
202
+ </ li >
203
+ < li class =" tsd-kind-module ">
204
+ < a href ="../modules/_api_context_.html "> "api/context"</ a >
205
+ </ li >
206
+ < li class ="current tsd-kind-module ">
207
+ < a href ="../modules/_api_keyboard_.html "> "api/keyboard"</ a >
208
+ </ li >
209
+ < li class =" tsd-kind-module ">
210
+ < a href ="../modules/_bot_.html "> "bot"</ a >
211
+ </ li >
212
+ < li class =" tsd-kind-module ">
213
+ < a href ="../modules/_core_.html "> "core"</ a >
214
+ </ li >
215
+ < li class =" tsd-kind-module ">
216
+ < a href ="../modules/_extra_log_.html "> "extra/log"</ a >
217
+ </ li >
218
+ < li class =" tsd-kind-module ">
219
+ < a href ="../modules/_extra_stats_.html "> "extra/stats"</ a >
220
+ </ li >
221
+ < li class =" tsd-kind-module ">
222
+ < a href ="../modules/_main_.html "> "main"</ a >
223
+ </ li >
224
+ </ ul >
225
+ </ nav >
226
+ < nav class ="tsd-navigation secondary menu-sticky ">
227
+ < ul class ="before-current ">
228
+ < li class =" tsd-kind-enum tsd-parent-kind-module ">
229
+ < a href ="../enums/_api_keyboard_.color.html " class ="tsd-kind-icon "> Color</ a >
230
+ </ li >
231
+ </ ul >
232
+ < ul class ="current ">
233
+ < li class ="current tsd-kind-class tsd-parent-kind-module ">
234
+ < a href ="_api_keyboard_.keyboard.html " class ="tsd-kind-icon "> Keyboard</ a >
235
+ < ul >
236
+ < li class =" tsd-kind-constructor tsd-parent-kind-class ">
237
+ < a href ="_api_keyboard_.keyboard.html#constructor " class ="tsd-kind-icon "> constructor</ a >
238
+ </ li >
239
+ < li class =" tsd-kind-property tsd-parent-kind-class ">
240
+ < a href ="_api_keyboard_.keyboard.html#buttons " class ="tsd-kind-icon "> buttons</ a >
241
+ </ li >
242
+ < li class =" tsd-kind-property tsd-parent-kind-class ">
243
+ < a href ="_api_keyboard_.keyboard.html#one_time " class ="tsd-kind-icon "> one_< wbr > time</ a >
244
+ </ li >
245
+ </ ul >
246
+ </ li >
247
+ </ ul >
248
+ < ul class ="after-current ">
249
+ < li class =" tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported ">
250
+ < a href ="../interfaces/_api_keyboard_.locationbutton.html " class ="tsd-kind-icon "> Location< wbr > Button</ a >
251
+ </ li >
252
+ < li class =" tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported ">
253
+ < a href ="../interfaces/_api_keyboard_.openappbutton.html " class ="tsd-kind-icon "> Open< wbr > App< wbr > Button</ a >
254
+ </ li >
255
+ < li class =" tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported ">
256
+ < a href ="../interfaces/_api_keyboard_.textbutton.html " class ="tsd-kind-icon "> Text< wbr > Button</ a >
257
+ </ li >
258
+ < li class =" tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported ">
259
+ < a href ="../interfaces/_api_keyboard_.vkpaybutton.html " class ="tsd-kind-icon "> VKPay< wbr > Button</ a >
260
+ </ li >
261
+ < li class =" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported ">
262
+ < a href ="../modules/_api_keyboard_.html#button " class ="tsd-kind-icon "> Button</ a >
263
+ </ li >
264
+ < li class =" tsd-kind-object-literal tsd-parent-kind-module ">
265
+ < a href ="../modules/_api_keyboard_.html#button-1 " class ="tsd-kind-icon "> button</ a >
266
+ </ li >
267
+ </ ul >
268
+ </ nav >
269
+ </ div >
270
+ </ div >
271
+ </ div >
272
+ < footer class ="with-border-bottom ">
273
+ < div class ="container ">
274
+ < h2 > Legend</ h2 >
275
+ < div class ="tsd-legend-group ">
276
+ < ul class ="tsd-legend ">
277
+ < li class ="tsd-kind-object-literal "> < span class ="tsd-kind-icon "> Object literal</ span > </ li >
278
+ < li class ="tsd-kind-variable "> < span class ="tsd-kind-icon "> Variable</ span > </ li >
279
+ < li class ="tsd-kind-function "> < span class ="tsd-kind-icon "> Function</ span > </ li >
280
+ < li class ="tsd-kind-function tsd-has-type-parameter "> < span class ="tsd-kind-icon "> Function with type parameter</ span > </ li >
281
+ < li class ="tsd-kind-type-alias "> < span class ="tsd-kind-icon "> Type alias</ span > </ li >
282
+ </ ul >
283
+ < ul class ="tsd-legend ">
284
+ < li class ="tsd-kind-class "> < span class ="tsd-kind-icon "> Class</ span > </ li >
285
+ < li class ="tsd-kind-constructor tsd-parent-kind-class "> < span class ="tsd-kind-icon "> Constructor</ span > </ li >
286
+ < li class ="tsd-kind-property tsd-parent-kind-class "> < span class ="tsd-kind-icon "> Property</ span > </ li >
287
+ </ ul >
288
+ < ul class ="tsd-legend ">
289
+ < li class ="tsd-kind-enum "> < span class ="tsd-kind-icon "> Enumeration</ span > </ li >
290
+ </ ul >
291
+ < ul class ="tsd-legend ">
292
+ < li class ="tsd-kind-interface "> < span class ="tsd-kind-icon "> Interface</ span > </ li >
293
+ </ ul >
294
+ </ div >
295
+ </ div >
296
+ </ footer >
297
+ < div class ="container tsd-generator ">
298
+ < p > Generated using < a href ="https://typedoc.org/ " target ="_blank "> TypeDoc</ a > </ p >
299
+ </ div >
300
+ < div class ="overlay "> </ div >
301
+ < script src ="../assets/js/main.js "> </ script >
302
+ < script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' ) ; </ script >
303
+ </ body >
304
+ </ html >
0 commit comments