Skip to content
This repository was archived by the owner on Aug 25, 2023. It is now read-only.

Commit 538015a

Browse files
committed
Documentation for the Keyboard object
1 parent 2d5dc03 commit 538015a

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Nodeogram is released under the GNU General Public License 3.0.
7777
objects/Chat
7878
objects/User
7979
objects/Message
80+
objects/Keyboard
8081
objects/CallbackQuery
8182
objects/ChosenInlineResult
8283
objects/ChatMember

docs/objects/Keyboard.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Keyboard
2+
========
3+
4+
This object represents Telegram's reply and inline keyboard markups.
5+
6+
==========================
7+
Message(keyboard, options)
8+
==========================
9+
10+
* ``keyboard`` <Array> Array of arrays of buttons, each one representing a row
11+
* ``options`` <Object> *Optional* Optional fields for both reply and inline keyboards, as defined by the Telegram API.
12+
13+
=============================
14+
addButton(row, index, button)
15+
=============================
16+
17+
* ``row`` <Number>
18+
* ``index`` <Number> The place of the button on the row. **Make sure that all preceding positions are filled!**
19+
* ``button`` <String>|<Object>
20+
21+
Adds a button to the keyboard. The ``button`` argument can both be a string (i.e. the text of the button, works only for
22+
reply keyboards) or an object with the corresponding properties (`inline <https://core.telegram.org/bots/api#inlinekeyboardbutton>`_
23+
and `reply <https://core.telegram.org/bots/api#keyboardbutton>`_ keyboards)
24+
25+
==========
26+
hide(bool)
27+
==========
28+
29+
* ``bool`` <Boolean> *Optional*. Whether or not the keyboard should be hidden. Defaults to true.
30+
31+
Setting this to true will make Telegram clients hide the current custom keyboard and display the default letter-keyboard.
32+
33+
==========
34+
toInline()
35+
==========
36+
37+
Makes this an inline keyboard. It can't be undone.

0 commit comments

Comments
 (0)