mirror of
https://github.com/yagop/node-telegram-bot-api
synced 2025-08-22 18:07:16 +00:00
Update readme
This commit is contained in:
parent
d1700788a1
commit
743cc0ff9d
16
README.md
16
README.md
@ -58,6 +58,7 @@ TelegramBot
|
||||
|
||||
* [TelegramBot](#TelegramBot)
|
||||
* [new TelegramBot(token, [options])](#new_TelegramBot_new)
|
||||
* [.stopPolling()](#TelegramBot+stopPolling) ⇒ <code>Promise</code>
|
||||
* [.getMe()](#TelegramBot+getMe) ⇒ <code>Promise</code>
|
||||
* [.setWebHook(url, [cert])](#TelegramBot+setWebHook)
|
||||
* [.getUpdates([timeout], [limit], [offset])](#TelegramBot+getUpdates) ⇒ <code>Promise</code>
|
||||
@ -104,6 +105,13 @@ Emits `message` when a message arrives.
|
||||
| [options.webHook.key] | <code>String</code> | | PEM private key to webHook server. |
|
||||
| [options.webHook.cert] | <code>String</code> | | PEM certificate (public) to webHook server. |
|
||||
|
||||
<a name="TelegramBot+stopPolling"></a>
|
||||
|
||||
### telegramBot.stopPolling() ⇒ <code>Promise</code>
|
||||
Stops polling after the last polling request resolves
|
||||
|
||||
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||
**Returns**: <code>Promise</code> - promise Promise, of last polling request
|
||||
<a name="TelegramBot+getMe"></a>
|
||||
|
||||
### telegramBot.getMe() ⇒ <code>Promise</code>
|
||||
@ -362,7 +370,7 @@ Note that you must provide one of chat_id, message_id, or
|
||||
inline_message_id in your request.
|
||||
|
||||
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||
**See**: https://core.telegram.org/bots/api#editmessagetext
|
||||
**See**: https://core.telegram.org/bots/api#editmessagecaption
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
@ -489,10 +497,4 @@ Register a reply to wait for a message response.
|
||||
| messageId | <code>Number</code> | <code>String</code> | The message id to be replied. |
|
||||
| callback | <code>function</code> | Callback will be called with the reply message. |
|
||||
|
||||
### telegramBot.stopPolling() => Promise
|
||||
Stops polling after the last polling request resolves.
|
||||
|
||||
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||
**Returns**: <code>Promise</code> - The resolved promise for the last poll request
|
||||
|
||||
* * *
|
||||
|
Loading…
x
Reference in New Issue
Block a user