mirror of
https://github.com/yagop/node-telegram-bot-api
synced 2025-08-24 19:08:11 +00:00
src/telegram: Update TelegramBot#answerCallbackQuery() signature
Feature: The signature is inconsistent from other methods in TelegramBot. Make it consistent. References: * FR: https://github.com/yagop/node-telegram-bot-api/issues/367 * PR: https://github.com/yagop/node-telegram-bot-api/pull/368 * PR-by: @mnb3000
This commit is contained in:
parent
f20a7f4ee5
commit
67839b6faa
@ -15,3 +15,4 @@
|
|||||||
[setWebHook-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
|
[setWebHook-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
|
||||||
[getUpdates-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
|
[getUpdates-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
|
||||||
[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
|
[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
|
||||||
|
[answerCallbackQuery-v0.27.1]:https://github.com/yagop/node-telegram-bot-api/blob/v0.27.1/doc/api.md#TelegramBot+answerCallbackQuery
|
||||||
|
11
doc/api.md
11
doc/api.md
@ -47,7 +47,7 @@ TelegramBot
|
|||||||
* [.setChatDescription(chatId, description)](#TelegramBot+setChatDescription) ⇒ <code>Promise</code>
|
* [.setChatDescription(chatId, description)](#TelegramBot+setChatDescription) ⇒ <code>Promise</code>
|
||||||
* [.pinChatMessage(chatId, messageId)](#TelegramBot+pinChatMessage) ⇒ <code>Promise</code>
|
* [.pinChatMessage(chatId, messageId)](#TelegramBot+pinChatMessage) ⇒ <code>Promise</code>
|
||||||
* [.unpinChatMessage(chatId)](#TelegramBot+unpinChatMessage) ⇒ <code>Promise</code>
|
* [.unpinChatMessage(chatId)](#TelegramBot+unpinChatMessage) ⇒ <code>Promise</code>
|
||||||
* [.answerCallbackQuery(callbackQueryId, text, showAlert, [options])](#TelegramBot+answerCallbackQuery) ⇒ <code>Promise</code>
|
* [.answerCallbackQuery([options])](#TelegramBot+answerCallbackQuery) ⇒ <code>Promise</code>
|
||||||
* [.editMessageText(text, [options])](#TelegramBot+editMessageText) ⇒ <code>Promise</code>
|
* [.editMessageText(text, [options])](#TelegramBot+editMessageText) ⇒ <code>Promise</code>
|
||||||
* [.editMessageCaption(caption, [options])](#TelegramBot+editMessageCaption) ⇒ <code>Promise</code>
|
* [.editMessageCaption(caption, [options])](#TelegramBot+editMessageCaption) ⇒ <code>Promise</code>
|
||||||
* [.editMessageReplyMarkup(replyMarkup, [options])](#TelegramBot+editMessageReplyMarkup) ⇒ <code>Promise</code>
|
* [.editMessageReplyMarkup(replyMarkup, [options])](#TelegramBot+editMessageReplyMarkup) ⇒ <code>Promise</code>
|
||||||
@ -569,20 +569,20 @@ Returns True on success.
|
|||||||
|
|
||||||
<a name="TelegramBot+answerCallbackQuery"></a>
|
<a name="TelegramBot+answerCallbackQuery"></a>
|
||||||
|
|
||||||
### telegramBot.answerCallbackQuery(callbackQueryId, text, showAlert, [options]) ⇒ <code>Promise</code>
|
### telegramBot.answerCallbackQuery([options]) ⇒ <code>Promise</code>
|
||||||
Use this method to send answers to callback queries sent from
|
Use this method to send answers to callback queries sent from
|
||||||
inline keyboards. The answer will be displayed to the user as
|
inline keyboards. The answer will be displayed to the user as
|
||||||
a notification at the top of the chat screen or as an alert.
|
a notification at the top of the chat screen or as an alert.
|
||||||
On success, True is returned.
|
On success, True is returned.
|
||||||
|
|
||||||
|
This method has an [older, compatible signature][answerCallbackQuery-v0.27.1]
|
||||||
|
that is being deprecated.
|
||||||
|
|
||||||
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||||
**See**: https://core.telegram.org/bots/api#answercallbackquery
|
**See**: https://core.telegram.org/bots/api#answercallbackquery
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| callbackQueryId | <code>Number</code> | <code>String</code> | Unique identifier for the query to be answered |
|
|
||||||
| text | <code>String</code> | Text of the notification. If not specified, nothing will be shown to the user |
|
|
||||||
| showAlert | <code>Boolean</code> | Whether to show an alert or a notification at the top of the screen |
|
|
||||||
| [options] | <code>Object</code> | Additional Telegram query options |
|
| [options] | <code>Object</code> | Additional Telegram query options |
|
||||||
|
|
||||||
<a name="TelegramBot+editMessageText"></a>
|
<a name="TelegramBot+editMessageText"></a>
|
||||||
@ -981,3 +981,4 @@ Use this method to confirm shipping of a product.
|
|||||||
[setWebHook-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
|
[setWebHook-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
|
||||||
[getUpdates-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
|
[getUpdates-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
|
||||||
[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
|
[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
|
||||||
|
[answerCallbackQuery-v0.27.1]:https://github.com/yagop/node-telegram-bot-api/blob/v0.27.1/doc/api.md#TelegramBot+answerCallbackQuery
|
||||||
|
@ -1001,17 +1001,27 @@ class TelegramBot extends EventEmitter {
|
|||||||
* a notification at the top of the chat screen or as an alert.
|
* a notification at the top of the chat screen or as an alert.
|
||||||
* On success, True is returned.
|
* On success, True is returned.
|
||||||
*
|
*
|
||||||
* @param {Number|String} callbackQueryId Unique identifier for the query to be answered
|
* This method has an [older, compatible signature][answerCallbackQuery-v0.27.1]
|
||||||
* @param {String} text Text of the notification. If not specified, nothing will be shown to the user
|
* that is being deprecated.
|
||||||
* @param {Boolean} showAlert Whether to show an alert or a notification at the top of the screen
|
*
|
||||||
* @param {Object} [options] Additional Telegram query options
|
* @param {Object} [options] Additional Telegram query options
|
||||||
* @return {Promise}
|
* @return {Promise}
|
||||||
* @see https://core.telegram.org/bots/api#answercallbackquery
|
* @see https://core.telegram.org/bots/api#answercallbackquery
|
||||||
*/
|
*/
|
||||||
answerCallbackQuery(callbackQueryId, text, showAlert, form = {}) {
|
answerCallbackQuery(form = {}) {
|
||||||
form.callback_query_id = callbackQueryId;
|
/* The older method signature was answerCallbackQuery(callbackQueryId, text, showAlert).
|
||||||
form.text = text;
|
* We need to ensure backwards-compatibility while maintaining
|
||||||
form.show_alert = showAlert;
|
* consistency of the method signatures throughout the library */
|
||||||
|
if (typeof form !== 'object') {
|
||||||
|
/* eslint-disable no-param-reassign, prefer-rest-params */
|
||||||
|
deprecate('The method signature answerCallbackQuery(callbackQueryId, text, showAlert) has been deprecated since v0.27.1');
|
||||||
|
form = {
|
||||||
|
callback_query_id: arguments[0],
|
||||||
|
text: arguments[1],
|
||||||
|
show_alert: arguments[2],
|
||||||
|
};
|
||||||
|
/* eslint-enable no-param-reassign, prefer-rest-params */
|
||||||
|
}
|
||||||
return this._request('answerCallbackQuery', { form });
|
return this._request('answerCallbackQuery', { form });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user