doc: Improve project documentation

2025-08-31 14:25:57 +00:00 · 2017-01-11 18:18:24 +03:00
parent e77c5ad8ec
commit ef3574ee88
11 changed files with 1239 additions and 820 deletions
--- a/doc/api.hbs
+++ b/doc/api.hbs
@@ -0,0 +1,15 @@
+# API Reference
+
+{{#class name="TelegramBot"~}}
+{{>header~}}
+{{>body~}}
+{{>member-index~}}
+{{>members~}}
+{{/class}}
+* * *
+
+
+[usage-sending-files-performance]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/usage.md#sending-files-performance
+[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
+[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
--- a/doc/api.md
+++ b/doc/api.md
@@ -0,0 +1,716 @@
+# API Reference
+
+<a name="TelegramBot"></a>
+
+## TelegramBot
+TelegramBot
+
+**Kind**: global class  
+**See**: https://core.telegram.org/bots/api  
+
+* [TelegramBot](#TelegramBot)
+    * [new TelegramBot(token, [options])](#new_TelegramBot_new)
+    * [.startPolling([options])](#TelegramBot+startPolling) ⇒ <code>Promise</code>
+    * ~~[.initPolling([options])](#TelegramBot+initPolling) ⇒ <code>Promise</code>~~
+    * [.stopPolling()](#TelegramBot+stopPolling) ⇒ <code>Promise</code>
+    * [.isPolling()](#TelegramBot+isPolling) ⇒ <code>Boolean</code>
+    * [.openWebHook()](#TelegramBot+openWebHook) ⇒ <code>Promise</code>
+    * [.closeWebHook()](#TelegramBot+closeWebHook) ⇒ <code>Promise</code>
+    * [.hasOpenWebHook()](#TelegramBot+hasOpenWebHook) ⇒ <code>Boolean</code>
+    * [.getMe()](#TelegramBot+getMe) ⇒ <code>Promise</code>
+    * [.setWebHook(url, [options])](#TelegramBot+setWebHook) ⇒ <code>Promise</code>
+    * [.deleteWebHook()](#TelegramBot+deleteWebHook) ⇒ <code>Promise</code>
+    * [.getWebHookInfo()](#TelegramBot+getWebHookInfo) ⇒ <code>Promise</code>
+    * [.getUpdates([options])](#TelegramBot+getUpdates) ⇒ <code>Promise</code>
+    * [.processUpdate(update)](#TelegramBot+processUpdate)
+    * [.sendMessage(chatId, text, [options])](#TelegramBot+sendMessage) ⇒ <code>Promise</code>
+    * [.answerInlineQuery(inlineQueryId, results, [options])](#TelegramBot+answerInlineQuery) ⇒ <code>Promise</code>
+    * [.forwardMessage(chatId, fromChatId, messageId, [options])](#TelegramBot+forwardMessage) ⇒ <code>Promise</code>
+    * [.sendPhoto(chatId, photo, [options])](#TelegramBot+sendPhoto) ⇒ <code>Promise</code>
+    * [.sendAudio(chatId, audio, [options])](#TelegramBot+sendAudio) ⇒ <code>Promise</code>
+    * [.sendDocument(chatId, doc, [options], [fileOpts])](#TelegramBot+sendDocument) ⇒ <code>Promise</code>
+    * [.sendSticker(chatId, sticker, [options])](#TelegramBot+sendSticker) ⇒ <code>Promise</code>
+    * [.sendVideo(chatId, video, [options])](#TelegramBot+sendVideo) ⇒ <code>Promise</code>
+    * [.sendVoice(chatId, voice, [options])](#TelegramBot+sendVoice) ⇒ <code>Promise</code>
+    * [.sendChatAction(chatId, action)](#TelegramBot+sendChatAction) ⇒ <code>Promise</code>
+    * [.kickChatMember(chatId, userId)](#TelegramBot+kickChatMember) ⇒ <code>Promise</code>
+    * [.unbanChatMember(chatId, userId)](#TelegramBot+unbanChatMember) ⇒ <code>Promise</code>
+    * [.answerCallbackQuery(callbackQueryId, text, showAlert, [options])](#TelegramBot+answerCallbackQuery) ⇒ <code>Promise</code>
+    * [.editMessageText(text, [options])](#TelegramBot+editMessageText) ⇒ <code>Promise</code>
+    * [.editMessageCaption(caption, [options])](#TelegramBot+editMessageCaption) ⇒ <code>Promise</code>
+    * [.editMessageReplyMarkup(replyMarkup, [options])](#TelegramBot+editMessageReplyMarkup) ⇒ <code>Promise</code>
+    * [.getUserProfilePhotos(userId, [options])](#TelegramBot+getUserProfilePhotos) ⇒ <code>Promise</code>
+    * [.sendLocation(chatId, latitude, longitude, [options])](#TelegramBot+sendLocation) ⇒ <code>Promise</code>
+    * [.sendVenue(chatId, latitude, longitude, title, address, [options])](#TelegramBot+sendVenue) ⇒ <code>Promise</code>
+    * [.sendContact(chatId, phoneNumber, firstName, [options])](#TelegramBot+sendContact) ⇒ <code>Promise</code>
+    * [.getFile(fileId)](#TelegramBot+getFile) ⇒ <code>Promise</code>
+    * [.getFileLink(fileId)](#TelegramBot+getFileLink) ⇒ <code>Promise</code>
+    * [.downloadFile(fileId, downloadDir)](#TelegramBot+downloadFile) ⇒ <code>Promise</code>
+    * [.onText(regexp, callback)](#TelegramBot+onText)
+    * [.onReplyToMessage(chatId, messageId, callback)](#TelegramBot+onReplyToMessage)
+    * [.getChat(chatId)](#TelegramBot+getChat) ⇒ <code>Promise</code>
+    * [.getChatAdministrators(chatId)](#TelegramBot+getChatAdministrators) ⇒ <code>Promise</code>
+    * [.getChatMembersCount(chatId)](#TelegramBot+getChatMembersCount) ⇒ <code>Promise</code>
+    * [.getChatMember(chatId, userId)](#TelegramBot+getChatMember) ⇒ <code>Promise</code>
+    * [.leaveChat(chatId)](#TelegramBot+leaveChat) ⇒ <code>Promise</code>
+    * [.sendGame(chatId, gameShortName, [options])](#TelegramBot+sendGame) ⇒ <code>Promise</code>
+    * [.setGameScore(userId, score, [options])](#TelegramBot+setGameScore) ⇒ <code>Promise</code>
+    * [.getGameHighScores(userId, [options])](#TelegramBot+getGameHighScores) ⇒ <code>Promise</code>
+
+<a name="new_TelegramBot_new"></a>
+
+### new TelegramBot(token, [options])
+Both request method to obtain messages are implemented. To use standard polling, set `polling: true`
+on `options`. Notice that [webHook](https://core.telegram.org/bots/api#setwebhook) will need a SSL certificate.
+Emits `message` when a message arrives.
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| token | <code>String</code> |  | Bot Token |
+| [options] | <code>Object</code> |  |  |
+| [options.polling] | <code>Boolean</code> &#124; <code>Object</code> | <code>false</code> | Set true to enable polling or set options.  If a WebHook has been set, it will be deleted automatically. |
+| [options.polling.timeout] | <code>String</code> &#124; <code>Number</code> | <code>10</code> | Timeout in seconds for long polling |
+| [options.polling.interval] | <code>String</code> &#124; <code>Number</code> | <code>300</code> | Interval between requests in miliseconds |
+| [options.polling.autoStart] | <code>Boolean</code> | <code>true</code> | Start polling immediately |
+| [options.webHook] | <code>Boolean</code> &#124; <code>Object</code> | <code>false</code> | Set true to enable WebHook or set options |
+| [options.webHook.port] | <code>Number</code> | <code>8443</code> | Port to bind to |
+| [options.webHook.key] | <code>String</code> |  | Path to file with PEM private key for webHook server.  The file is read **synchronously**! |
+| [options.webHook.cert] | <code>String</code> |  | Path to file with PEM certificate (public) for webHook server.  The file is read **synchronously**! |
+| [options.webHook.pfx] | <code>String</code> |  | Path to file with PFX private key and certificate chain for webHook server.  The file is read **synchronously**! |
+| [options.webHook.autoOpen] | <code>Boolean</code> | <code>true</code> | Open webHook immediately |
+| [options.webHook.https] | <code>Object</code> |  | Options to be passed to `https.createServer()`.  Note that `options.webHook.key`, `options.webHook.cert` and `options.webHook.pfx`, if provided, will be  used to override `key`, `cert` and `pfx` in this object, respectively.  See https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener for more information. |
+| [options.onlyFirstMatch] | <code>Boolean</code> | <code>false</code> | Set to true to stop after first match. Otherwise, all regexps are executed |
+| [options.request] | <code>Object</code> |  | Options which will be added for all requests to telegram api.  See https://github.com/request/request#requestoptions-callback for more information. |
+| [options.baseApiUrl] | <code>String</code> | <code>https://api.telegram.org</code> | API Base URl; useful for proxying and testing |
+| [options.filepath] | <code>Boolean</code> | <code>true</code> | Allow passing file-paths as arguments when sending files,  such as photos using `TelegramBot#sendPhoto()`. See [usage information][usage-sending-files-performance]  for more information on this option and its consequences. |
+
+<a name="TelegramBot+startPolling"></a>
+
+### telegramBot.startPolling([options]) ⇒ <code>Promise</code>
+Start polling.
+Rejects returned promise if a WebHook is being used by this instance.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [options] | <code>Object</code> |  |  |
+| [options.restart] | <code>Boolean</code> | <code>true</code> | Consecutive calls to this method causes polling to be restarted |
+
+<a name="TelegramBot+initPolling"></a>
+
+### ~~telegramBot.initPolling([options]) ⇒ <code>Promise</code>~~
+***Deprecated***
+
+Alias of `TelegramBot#startPolling()`. This is **deprecated**.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+
+| Param | Type |
+| --- | --- |
+| [options] | <code>Object</code> | 
+
+<a name="TelegramBot+stopPolling"></a>
+
+### telegramBot.stopPolling() ⇒ <code>Promise</code>
+Stops polling after the last polling request resolves.
+Multiple invocations do nothing if polling is already stopped.
+Returning the promise of the last polling request is **deprecated**.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+<a name="TelegramBot+isPolling"></a>
+
+### telegramBot.isPolling() ⇒ <code>Boolean</code>
+Return true if polling. Otherwise, false.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+<a name="TelegramBot+openWebHook"></a>
+
+### telegramBot.openWebHook() ⇒ <code>Promise</code>
+Open webhook.
+Multiple invocations do nothing if webhook is already open.
+Rejects returned promise if Polling is being used by this instance.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+<a name="TelegramBot+closeWebHook"></a>
+
+### telegramBot.closeWebHook() ⇒ <code>Promise</code>
+Close webhook after closing all current connections.
+Multiple invocations do nothing if webhook is already closed.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**Returns**: <code>Promise</code> - promise  
+<a name="TelegramBot+hasOpenWebHook"></a>
+
+### telegramBot.hasOpenWebHook() ⇒ <code>Boolean</code>
+Return true if using webhook and it is open i.e. accepts connections.
+Otherwise, false.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+<a name="TelegramBot+getMe"></a>
+
+### telegramBot.getMe() ⇒ <code>Promise</code>
+Returns basic information about the bot in form of a `User` object.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getme  
+<a name="TelegramBot+setWebHook"></a>
+
+### telegramBot.setWebHook(url, [options]) ⇒ <code>Promise</code>
+Specify an url to receive incoming updates via an outgoing webHook.
+This method has an [older, compatible signature][setWebHook-v0.25.0]
+that is being deprecated.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#setwebhook  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | <code>String</code> | URL where Telegram will make HTTP Post. Leave empty to delete webHook. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+| [options.certificate] | <code>String</code> &#124; <code>stream.Stream</code> | PEM certificate key (public). |
+
+<a name="TelegramBot+deleteWebHook"></a>
+
+### telegramBot.deleteWebHook() ⇒ <code>Promise</code>
+Use this method to remove webhook integration if you decide to
+switch back to getUpdates. Returns True on success.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#deletewebhook  
+<a name="TelegramBot+getWebHookInfo"></a>
+
+### telegramBot.getWebHookInfo() ⇒ <code>Promise</code>
+Use this method to get current webhook status.
+On success, returns a [WebhookInfo](https://core.telegram.org/bots/api#webhookinfo) object.
+If the bot is using getUpdates, will return an object with the
+url field empty.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getwebhookinfo  
+<a name="TelegramBot+getUpdates"></a>
+
+### telegramBot.getUpdates([options]) ⇒ <code>Promise</code>
+Use this method to receive incoming updates using long polling.
+This method has an [older, compatible signature][getUpdates-v0.25.0]
+that is being deprecated.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getupdates  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+processUpdate"></a>
+
+### telegramBot.processUpdate(update)
+Process an update; emitting the proper events and executing regexp
+callbacks. This method is useful should you be using a different
+way to fetch updates, other than those provided by TelegramBot.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#update  
+
+| Param | Type |
+| --- | --- |
+| update | <code>Object</code> | 
+
+<a name="TelegramBot+sendMessage"></a>
+
+### telegramBot.sendMessage(chatId, text, [options]) ⇒ <code>Promise</code>
+Send text message.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendmessage  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| text | <code>String</code> | Text of the message to be sent |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+answerInlineQuery"></a>
+
+### telegramBot.answerInlineQuery(inlineQueryId, results, [options]) ⇒ <code>Promise</code>
+Send answers to an inline query.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#answerinlinequery  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| inlineQueryId | <code>String</code> | Unique identifier of the query |
+| results | <code>Array.&lt;InlineQueryResult&gt;</code> | An array of results for the inline query |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+forwardMessage"></a>
+
+### telegramBot.forwardMessage(chatId, fromChatId, messageId, [options]) ⇒ <code>Promise</code>
+Forward messages of any kind.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| fromChatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the chat where the original message was sent |
+| messageId | <code>Number</code> &#124; <code>String</code> | Unique message identifier |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendPhoto"></a>
+
+### telegramBot.sendPhoto(chatId, photo, [options]) ⇒ <code>Promise</code>
+Send photo
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendphoto  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| photo | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path or a Stream. Can also be a `file_id` previously uploaded |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendAudio"></a>
+
+### telegramBot.sendAudio(chatId, audio, [options]) ⇒ <code>Promise</code>
+Send audio
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendaudio  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| audio | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path, Stream or Buffer. Can also be a `file_id` previously uploaded. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendDocument"></a>
+
+### telegramBot.sendDocument(chatId, doc, [options], [fileOpts]) ⇒ <code>Promise</code>
+Send Document
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendDocument  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| doc | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path, Stream or Buffer. Can also be a `file_id` previously uploaded. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+| [fileOpts] | <code>Object</code> | Optional file related meta-data |
+
+<a name="TelegramBot+sendSticker"></a>
+
+### telegramBot.sendSticker(chatId, sticker, [options]) ⇒ <code>Promise</code>
+Send .webp stickers.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendsticker  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| sticker | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path, Stream or Buffer. Can also be a `file_id` previously uploaded. Stickers are WebP format files. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendVideo"></a>
+
+### telegramBot.sendVideo(chatId, video, [options]) ⇒ <code>Promise</code>
+Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendvideo  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| video | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path or Stream. Can also be a `file_id` previously uploaded. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendVoice"></a>
+
+### telegramBot.sendVoice(chatId, voice, [options]) ⇒ <code>Promise</code>
+Send voice
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendvoice  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| voice | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path, Stream or Buffer. Can also be a `file_id` previously uploaded. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendChatAction"></a>
+
+### telegramBot.sendChatAction(chatId, action) ⇒ <code>Promise</code>
+Send chat action.
+`typing` for text messages,
+`upload_photo` for photos, `record_video` or `upload_video` for videos,
+`record_audio` or `upload_audio` for audio files, `upload_document` for general files,
+`find_location` for location data.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendchataction  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| action | <code>String</code> | Type of action to broadcast. |
+
+<a name="TelegramBot+kickChatMember"></a>
+
+### telegramBot.kickChatMember(chatId, userId) ⇒ <code>Promise</code>
+Use this method to kick a user from a group or a supergroup.
+In the case of supergroups, the user will not be able to return
+to the group on their own using invite links, etc., unless unbanned
+first. The bot must be an administrator in the group for this to work.
+Returns True on success.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#kickchatmember  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
+| userId | <code>String</code> | Unique identifier of the target user |
+
+<a name="TelegramBot+unbanChatMember"></a>
+
+### telegramBot.unbanChatMember(chatId, userId) ⇒ <code>Promise</code>
+Use this method to unban a previously kicked user in a supergroup.
+The user will not return to the group automatically, but will be
+able to join via link, etc. The bot must be an administrator in
+the group for this to work. Returns True on success.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#unbanchatmember  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
+| userId | <code>String</code> | Unique identifier of the target user |
+
+<a name="TelegramBot+answerCallbackQuery"></a>
+
+### telegramBot.answerCallbackQuery(callbackQueryId, text, showAlert, [options]) ⇒ <code>Promise</code>
+Use this method to send answers to callback queries sent from
+inline keyboards. The answer will be displayed to the user as
+a notification at the top of the chat screen or as an alert.
+On success, True is returned.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#answercallbackquery  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| callbackQueryId | <code>Number</code> &#124; <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 |
+
+<a name="TelegramBot+editMessageText"></a>
+
+### telegramBot.editMessageText(text, [options]) ⇒ <code>Promise</code>
+Use this method to edit text messages sent by the bot or via
+the bot (for inline bots). On success, the edited Message is
+returned.
+
+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  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>String</code> | New text of the message |
+| [options] | <code>Object</code> | Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here) |
+
+<a name="TelegramBot+editMessageCaption"></a>
+
+### telegramBot.editMessageCaption(caption, [options]) ⇒ <code>Promise</code>
+Use this method to edit captions of messages sent by the
+bot or via the bot (for inline bots). On success, the
+edited Message is returned.
+
+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#editmessagecaption  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| caption | <code>String</code> | New caption of the message |
+| [options] | <code>Object</code> | Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here) |
+
+<a name="TelegramBot+editMessageReplyMarkup"></a>
+
+### telegramBot.editMessageReplyMarkup(replyMarkup, [options]) ⇒ <code>Promise</code>
+Use this method to edit only the reply markup of messages
+sent by the bot or via the bot (for inline bots).
+On success, the edited Message is returned.
+
+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  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| replyMarkup | <code>Object</code> | A JSON-serialized object for an inline keyboard. |
+| [options] | <code>Object</code> | Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here) |
+
+<a name="TelegramBot+getUserProfilePhotos"></a>
+
+### telegramBot.getUserProfilePhotos(userId, [options]) ⇒ <code>Promise</code>
+Use this method to get a list of profile pictures for a user.
+Returns a [UserProfilePhotos](https://core.telegram.org/bots/api#userprofilephotos) object.
+This method has an [older, compatible signature][getUserProfilePhotos-v0.25.0]
+that is being deprecated.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getuserprofilephotos  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userId | <code>Number</code> &#124; <code>String</code> | Unique identifier of the target user |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendLocation"></a>
+
+### telegramBot.sendLocation(chatId, latitude, longitude, [options]) ⇒ <code>Promise</code>
+Send location.
+Use this method to send point on the map.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendlocation  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| latitude | <code>Float</code> | Latitude of location |
+| longitude | <code>Float</code> | Longitude of location |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendVenue"></a>
+
+### telegramBot.sendVenue(chatId, latitude, longitude, title, address, [options]) ⇒ <code>Promise</code>
+Send venue.
+Use this method to send information about a venue.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendvenue  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| latitude | <code>Float</code> | Latitude of location |
+| longitude | <code>Float</code> | Longitude of location |
+| title | <code>String</code> | Name of the venue |
+| address | <code>String</code> | Address of the venue |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+sendContact"></a>
+
+### telegramBot.sendContact(chatId, phoneNumber, firstName, [options]) ⇒ <code>Promise</code>
+Send contact.
+Use this method to send phone contacts.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendcontact  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| phoneNumber | <code>String</code> | Contact's phone number |
+| firstName | <code>String</code> | Contact's first name |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+getFile"></a>
+
+### telegramBot.getFile(fileId) ⇒ <code>Promise</code>
+Get file.
+Use this method to get basic info about a file and prepare it for downloading.
+Attention: link will be valid for 1 hour.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getfile  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fileId | <code>String</code> | File identifier to get info about |
+
+<a name="TelegramBot+getFileLink"></a>
+
+### telegramBot.getFileLink(fileId) ⇒ <code>Promise</code>
+Get link for file.
+Use this method to get link for file for subsequent use.
+Attention: link will be valid for 1 hour.
+
+This method is a sugar extension of the (getFile)[#getfilefileid] method,
+which returns just path to file on remote server (you will have to manually build full uri after that).
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**Returns**: <code>Promise</code> - promise Promise which will have *fileURI* in resolve callback  
+**See**: https://core.telegram.org/bots/api#getfile  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fileId | <code>String</code> | File identifier to get info about |
+
+<a name="TelegramBot+downloadFile"></a>
+
+### telegramBot.downloadFile(fileId, downloadDir) ⇒ <code>Promise</code>
+Downloads file in the specified folder.
+This is just a sugar for (getFile)[#getfilefiled] method
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**Returns**: <code>Promise</code> - promise Promise, which will have *filePath* of downloaded file in resolve callback  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fileId | <code>String</code> | File identifier to get info about |
+| downloadDir | <code>String</code> | Absolute path to the folder in which file will be saved |
+
+<a name="TelegramBot+onText"></a>
+
+### telegramBot.onText(regexp, callback)
+Register a RegExp to test against an incomming text message.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| regexp | <code>RegExp</code> | RegExp to be executed with `exec`. |
+| callback | <code>function</code> | Callback will be called with 2 parameters, the `msg` and the result of executing `regexp.exec` on message text. |
+
+<a name="TelegramBot+onReplyToMessage"></a>
+
+### telegramBot.onReplyToMessage(chatId, messageId, callback)
+Register a reply to wait for a message response.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | The chat id where the message cames from. |
+| messageId | <code>Number</code> &#124; <code>String</code> | The message id to be replied. |
+| callback | <code>function</code> | Callback will be called with the reply message. |
+
+<a name="TelegramBot+getChat"></a>
+
+### telegramBot.getChat(chatId) ⇒ <code>Promise</code>
+Use this method to get up to date information about the chat
+(current name of the user for one-on-one conversations, current
+username of a user, group or channel, etc.).
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getchat  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup or channel |
+
+<a name="TelegramBot+getChatAdministrators"></a>
+
+### telegramBot.getChatAdministrators(chatId) ⇒ <code>Promise</code>
+Returns the administrators in a chat in form of an Array of `ChatMember` objects.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getchatadministrators  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
+
+<a name="TelegramBot+getChatMembersCount"></a>
+
+### telegramBot.getChatMembersCount(chatId) ⇒ <code>Promise</code>
+Use this method to get the number of members in a chat.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getchatmemberscount  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
+
+<a name="TelegramBot+getChatMember"></a>
+
+### telegramBot.getChatMember(chatId, userId) ⇒ <code>Promise</code>
+Use this method to get information about a member of a chat.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getchatmember  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
+| userId | <code>String</code> | Unique identifier of the target user |
+
+<a name="TelegramBot+leaveChat"></a>
+
+### telegramBot.leaveChat(chatId) ⇒ <code>Promise</code>
+Leave a group, supergroup or channel.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#leavechat  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) |
+
+<a name="TelegramBot+sendGame"></a>
+
+### telegramBot.sendGame(chatId, gameShortName, [options]) ⇒ <code>Promise</code>
+Use this method to send a game.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#sendgame  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient |
+| gameShortName | <code>String</code> | name of the game to be sent. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+setGameScore"></a>
+
+### telegramBot.setGameScore(userId, score, [options]) ⇒ <code>Promise</code>
+Use this method to set the score of the specified user in a game.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#setgamescore  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userId | <code>String</code> | Unique identifier of the target user |
+| score | <code>Number</code> | New score value. |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+getGameHighScores"></a>
+
+### telegramBot.getGameHighScores(userId, [options]) ⇒ <code>Promise</code>
+Use this method to get data for high score table.
+
+**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>  
+**See**: https://core.telegram.org/bots/api#getgamehighscores  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userId | <code>String</code> | Unique identifier of the target user |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+* * *
+
+
+[usage-sending-files-performance]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/usage.md#sending-files-performance
+[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
+[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
--- a/doc/help.md
+++ b/doc/help.md
@@ -0,0 +1,175 @@
+# Help Information
+
+* [Common Pitfalls](#pitfalls)
+* [FAQs](#faqs)
+
+
+* * *
+
+
+<a name="pitfalls"></a>
+## Common Pitfalls
+
+1. [Failing to receive reply with `ReplyToMessage`](#reply-to-message)
+
+
+---
+
+
+<a name="reply-to-message"></a>
+**Failing to receive reply with `ReplyToMessage`**
+
+The user has to **manually reply** to your message, by tapping on the
+bot's message and select *Reply*.
+
+Sources:
+
+  * Issue #113: https://github.com/yagop/node-telegram-bot-api/issues/113
+
+
+* * *
+
+
+<a name="faqs"></a>
+## Frequently Asked Questions
+
+> Check out [all questions ever asked][questions] on our Github Issues.
+
+[questions]:https://github.com/yagop/node-telegram-bot-api/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20
+
+1. [How do I send GIFs?](#gifs)
+1. [Why and When do I need a certificate when using WebHooks?](#webhook-cert)
+1. [How do I know when a user leaves a chat?](#leave-chat)
+1. [What does this error mean?](#error-meanings)
+1. [How do I know the selected option in reply keyboard?](#reply-keyboard)
+1. [How do I send multiple message in correct sequence?](#ordered-sending)
+1. [How do I run my bot behind a proxy?](#proxy)
+1. [Can you add feature X to the library?](#new-feature)
+1. [Is this scalable?](#scalable)
+
+
+---
+
+<a name="gifs"></a>
+**How do I send GIFs?**
+
+You might be trying to send your animated GIFs using *TelegramBot#sendPhoto()*.
+The method mostly supports static images. As noted by the community,
+it seems you need to send them as documents, using *TelegramBot#sendDocument()*.
+
+
+```js
+bot.sendDocument(chatId, "cat.gif");
+```
+
+Sources:
+
+  * Issue #11: https://github.com/yagop/node-telegram-bot-api/issues/11
+
+
+---
+
+
+<a name="webhook-cert"></a>
+**Why and When do I need a certificate when using WebHooks?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #63: https://github.com/yagop/node-telegram-bot-api/issues/63
+  * Issue #125: https://github.com/yagop/node-telegram-bot-api/issues/125
+
+
+---
+
+<a name="leave-chat"></a>
+**How do I know when a user leaves a chat?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #248: https://github.com/yagop/node-telegram-bot-api/issues/248
+
+
+---
+
+
+<a name="error-meanings"></a>
+**What does this error mean?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #73: https://github.com/yagop/node-telegram-bot-api/issues/73
+  * Issue #99: https://github.com/yagop/node-telegram-bot-api/issues/99
+  * Issue #101: https://github.com/yagop/node-telegram-bot-api/issues/101
+  * Issue #107: https://github.com/yagop/node-telegram-bot-api/issues/107
+  * Issue #156: https://github.com/yagop/node-telegram-bot-api/issues/156
+  * Issue #170: https://github.com/yagop/node-telegram-bot-api/issues/170
+  * Issue #244: https://github.com/yagop/node-telegram-bot-api/issues/244
+
+
+---
+
+
+<a name="reply-keyboard"></a>
+**How do I know the selected option in reply keyboard?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #108: https://github.com/yagop/node-telegram-bot-api/issues/108
+
+
+---
+
+
+<a name="ordered-sending"></a>
+**How do I send multiple message in correct sequence?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #240: https://github.com/yagop/node-telegram-bot-api/issues/240
+
+
+---
+
+
+<a name="proxy"></a>
+**How do I run my bot behind a proxy?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #122: https://github.com/yagop/node-telegram-bot-api/issues/122
+  * Issue #253: https://github.com/yagop/node-telegram-bot-api/issues/253
+
+
+---
+
+
+<a name="new-feature"></a>
+**Can you add feature X to the library?**
+
+*Not Done. Send PR please!*
+
+Sources:
+
+  * Issue #238: https://github.com/yagop/node-telegram-bot-api/issues/238
+
+
+---
+
+<a name="scalable"></a>
+**Is this scalable?**
+
+*Not Done. Send PR please!*
+
+---
--- a/doc/usage.md
+++ b/doc/usage.md
@@ -0,0 +1,147 @@
+# Usage
+
+1. [Events](#events)
+1. [WebHooks](#WebHooks)
+1. [Sending files](#sending-files)
+
+
+* * *
+
+
+<a name="events"></a>
+## Events
+
+*TelegramBot* is an event-emitter that emits the following events:
+
+1. `message`: Received a new incoming [Message][message] of any kind
+  1. Depending on the properties of the [Message][message], one of these
+     events will **ALSO** be emitted: `text`, `audio`, `document`, `photo`,
+     `sticker`, `video`, `voice`, `contact`, `location`,
+     `new_chat_participant`, `left_chat_participant`, `new_chat_title`,
+     `new_chat_photo`, `delete_chat_photo`, `group_chat_created`
+1. `callback_query`: Received a new incoming [Callback Query][callback-query]
+1. `inline_query`: Received a new incoming [Inline Query][inline-query]
+1. `chosen_inline_result`: Received result of an inline query i.e. [ChosenInlineResult][chosen-inline-result]
+1. `channel_post`: Received a new incoming channel post of any kind
+1. `edited_message`: Received a new version of a message that is known to the bot and was edited
+  1. `edited_message_text`
+  1. `edited_message_caption`
+1. `edited_channel_post`: Received a new version of a channel post that is known to the bot and was edited
+  1. `edited_channel_post_text`
+  1. `edited_channel_post_caption`
+
+**Tip:** Its much better to listen a specific event rather than on
+`message` in order to stay safe from the content.
+
+**Tip:** Bot must be enabled on [inline mode][inline-mode] for receive some
+messages.
+
+[update]:https://core.telegram.org/bots/api#update
+[message]:https://core.telegram.org/bots/api#message
+[callback-query]:https://core.telegram.org/bots/api#callbackquery
+[inline-query]:https://core.telegram.org/bots/api#inlinequery
+[chosen-inline-result]:https://core.telegram.org/bots/api#choseninlineresult
+[inline-mode]:https://core.telegram.org/bots/api#inline-mode
+
+
+* * *
+
+
+<a name="webhooks"></a>
+## WebHooks
+
+Telegram only supports HTTPS connections to WebHooks.
+Therefore, in order to set a WebHook, you will need a SSL certificate.
+Since August 29, 2015 Telegram supports self-signed ones, thus, you can
+generate them:
+
+```bash
+# Our private cert will be key.pem, keep this file private
+$ openssl genrsa -out key.pem 2048
+
+# Our public certificate will be crt.pem
+$ openssl req -new -sha256 -key key.pem -out crt.pem
+```
+
+Once they are generated, the `crt.pem` should be uploaded, when setting up
+your webhook. For example,
+
+```js
+bot.setWebHook("public-url.com", {
+  certificate: "path/to/crt.pem", // Path to your crt.pem
+});
+```
+
+**Note:** If you encounter an error, like
+`Error: error:0906D06C:PEM routines:PEM_read_bio:no start line`,
+you may want to proceed to [this issue][issue-63] for more information.
+
+[issue-63]:https://github.com/yagop/node-telegram-bot-api/issues/63
+
+
+* * *
+
+
+<a name="sending-files"></a>
+## Sending files
+
+The library makes it easy to get started sending files. *By default*, you
+may provide a **file-path** and the library will handle reading it for you.
+For example,
+
+```js
+bot.sendAudio(chatId, "path/to/audio.mp3");
+```
+
+You may also pass in a **Readable Stream** from which data will be piped.
+For example,
+
+```js
+const stream = fs.createReadStream("path/to/audio.mp3");
+bot.sendAudio(chatId, stream);
+```
+
+You may also pass in a **Buffer** containing the contents of your file.
+For example,
+
+```js
+const buffer = fs.readFileSync("path/to/audio.mp3"); // sync! that's sad! :-( Just making a point!
+bot.sendAudio(chatId, buffer);
+```
+
+If you already have a **File ID**, you earlier retrieved from Telegram,
+you may pass it in, for example:
+
+```js
+const fileId = getFileIdSomehow();
+bot.sendAudio(chatId, fileId);
+```
+
+Some API methods, such as *SendPhoto*, allow passing a **HTTP URL**, that
+the Telegram servers will use to download the file. For example,
+
+```js
+const url = "https://telegram.org/img/t_logo.png";
+bot.sendPhoto(chatId, url);
+```
+
+<a name="sending-files-performance"></a>
+### Performance Issue:
+
+To support providing file-paths to methods that send files involves
+performing a file operation, i.e. *fs.existsSync()*, that checks for
+the existence of the file at the provided path. While the cost of
+this operation *might* be negligible in most use cases, if you want
+to squeeze the best performance out of this library, you may wish to
+disable this behavior.
+
+This will mean that you will **NOT** be able to pass in file-paths.
+You will have to use Streams or Buffers to provide the file contents.
+
+Disabling this behavior:
+
+```js
+const bot = new TelegramBot(token, {
+  filepath: false,
+});
+```