vvlad1973-telegram-framework
Version:
Current version: *7.9.5*
580 lines (181 loc) • 10.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: reply_keyboard_markup</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: reply_keyboard_markup</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="reply_keyboard_markup.js.html">reply_keyboard_markup.js</a>, <a href="reply_keyboard_markup.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="module-reply_keyboard_markup.ReplyKeyboardMarkup.html">ReplyKeyboardMarkup</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id=".KeyboardButton">KeyboardButton</h4>
<div class="description">
This object
represents one button of the reply keyboard. For simple text buttons,
String can be used instead of this object to specify the button text.
The optional fields web_app, request_user, request_chat, request_contact,
request_location, and request_poll are mutually exclusive
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">Text of the button. If none of the optional fields
are used, it will be sent as a message when the button is pressed</td>
</tr>
<tr>
<td class="name"><code>request_user</code></td>
<td class="type">
<span class="param-type">module:reply_keyboard_markup.KeyboardButtonRequestUser</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If specified, pressing the button will open a list of suitable users.
Tapping on any user will send their identifier to the bot in a “user_shared”
service message. Available in private chats only</td>
</tr>
<tr>
<td class="name"><code>request_chat</code></td>
<td class="type">
<span class="param-type">module:reply_keyboard_markup.KeyboardButtonRequestChat</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If specified, pressing the button will open a list of suitable chats.
Tapping on a chat will send its identifier to the bot in a “chat_shared”
service message. Available in private chats only</td>
</tr>
<tr>
<td class="name"><code>request_contact</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If True, the user's phone number
will be sent as a contact when the button is pressed. Available in
private chats only</td>
</tr>
<tr>
<td class="name"><code>request_location</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If True, the user's current
location will be sent when the button is pressed. Available in private
chats only</td>
</tr>
<tr>
<td class="name"><code>request_poll</code></td>
<td class="type">
<span class="param-type">module:reply_keyboard_markup.KeyboardButtonPollType</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If specified, the user will be asked to create a poll and send it to the
bot when the button is pressed. Available in private chats only</td>
</tr>
<tr>
<td class="name"><code>web_app</code></td>
<td class="type">
<span class="param-type"><a href="module-reply_keyboard_markup.html#.WebAppInfo">module:reply_keyboard_markup.WebAppInfo</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If specified,
the described Web App will be launched when the button is pressed. The
Web App will be able to send a “web_app_data” service message. Available
in private chats only</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="reply_keyboard_markup.js.html">reply_keyboard_markup.js</a>, <a href="reply_keyboard_markup.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".WebAppInfo">WebAppInfo</h4>
<div class="description">
Describes a Web App
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">An HTTPS URL of a Web App to be opened with additional data
as specified in Initializing Web Apps</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="reply_keyboard_markup.js.html">reply_keyboard_markup.js</a>, <a href="reply_keyboard_markup.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-base_telegram_bot.html">base_telegram_bot</a></li><li><a href="module-bot_commands.html">bot_commands</a></li><li><a href="module-enums.html">enums</a></li><li><a href="module-inline_keyboard_markup.html">inline_keyboard_markup</a></li><li><a href="module-reply_keyboard_markup.html">reply_keyboard_markup</a></li><li><a href="module-sender.html">sender</a></li></ul><h3>Classes</h3><ul><li><a href="module-base_telegram_bot.BaseTelegramBot.html">BaseTelegramBot</a></li><li><a href="module-bot_commands-BotCommandsArray.html">BotCommandsArray</a></li><li><a href="module-inline_keyboard_markup.InlineKeyboardMarkup.html">InlineKeyboardMarkup</a></li><li><a href="module-reply_keyboard_markup.ReplyKeyboardMarkup.html">ReplyKeyboardMarkup</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sun Mar 26 2023 20:28:31 GMT+0300 (Москва, стандартное время)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>