mir/node-telegram-bot-api
2
0
Fork 0
mirror of https://github.com/yagop/node-telegram-bot-api synced 2025-08-22 18:07:16 +00:00
Code Issues Releases Wiki Activity

doc: Update API Reference, fix minor typo

Browse Source
This commit is contained in:
GochoMugo 2017-05-10 09:02:44 +03:00
parent 673e09cd08
commit 959d7bfd2e
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api.md
View File

@ -60,6 +60,7 @@ TelegramBot
* [.sendGame(chatId, gameShortName, [options])](#TelegramBot+sendGame) ⇒ <code>Promise</code> * [.sendGame(chatId, gameShortName, [options])](#TelegramBot+sendGame) ⇒ <code>Promise</code>
* [.setGameScore(userId, score, [options])](#TelegramBot+setGameScore) ⇒ <code>Promise</code> * [.setGameScore(userId, score, [options])](#TelegramBot+setGameScore) ⇒ <code>Promise</code>
* [.getGameHighScores(userId, [options])](#TelegramBot+getGameHighScores) ⇒ <code>Promise</code> * [.getGameHighScores(userId, [options])](#TelegramBot+getGameHighScores) ⇒ <code>Promise</code>
* [.deleteMessage(chatId, messageId, [options])](#TelegramBot+deleteMessage) ⇒ <code>Promise</code>
<a name="new_TelegramBot_new"></a> <a name="new_TelegramBot_new"></a>
@ -744,6 +745,20 @@ Use this method to get data for high score table.
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>String</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+deleteMessage"></a>
### telegramBot.deleteMessage(chatId, messageId, [options]) ⇒ <code>Promise</code>
Use this method to delete a message.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
**See**: https://core.telegram.org/bots/api#deletemessage
| Param | Type | Description |
| --- | --- | --- |
| chatId | <code>String</code> | Unique identifier of the target chat |
| messageId | <code>String</code> | Unique identifier of the target message |
| [options] | <code>Object</code> | Additional Telegram query options |
* * * * * *

1
src/telegram.js
View File

@ -1168,7 +1168,6 @@ class TelegramBot extends EventEmitter {
return this._request('getGameHighScores', { form }); return this._request('getGameHighScores', { form });
} }
/** /**
* Use this method to delete a message. * Use this method to delete a message.
* @param {String} chatId Unique identifier of the target chat * @param {String} chatId Unique identifier of the target chat