From 743cc0ff9db3f039331d1b7dadb2a13a58ceff0d Mon Sep 17 00:00:00 2001 From: Yago Date: Thu, 7 Jul 2016 23:51:13 +0200 Subject: [PATCH] Update readme --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 336235c..01607d5 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ TelegramBot * [TelegramBot](#TelegramBot) * [new TelegramBot(token, [options])](#new_TelegramBot_new) + * [.stopPolling()](#TelegramBot+stopPolling) ⇒ Promise * [.getMe()](#TelegramBot+getMe) ⇒ Promise * [.setWebHook(url, [cert])](#TelegramBot+setWebHook) * [.getUpdates([timeout], [limit], [offset])](#TelegramBot+getUpdates) ⇒ Promise @@ -104,6 +105,13 @@ Emits `message` when a message arrives. | [options.webHook.key] | String | | PEM private key to webHook server. | | [options.webHook.cert] | String | | PEM certificate (public) to webHook server. | + + +### telegramBot.stopPolling() ⇒ Promise +Stops polling after the last polling request resolves + +**Kind**: instance method of [TelegramBot](#TelegramBot) +**Returns**: Promise - promise Promise, of last polling request ### telegramBot.getMe() ⇒ Promise @@ -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 [TelegramBot](#TelegramBot) -**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 | Number | String | The message id to be replied. | | callback | function | Callback will be called with the reply message. | -### telegramBot.stopPolling() => Promise -Stops polling after the last polling request resolves. - -**Kind**: instance method of [TelegramBot](#TelegramBot) -**Returns**: Promise - The resolved promise for the last poll request - * * *