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

chore/deps: Update dependencies

Browse Source 
Notes:

  Kept-back:
  ---------
  1. eslint-config-airbnb
  2. file-type
  3. istanbul
  4. mime
  5. mocha
This commit is contained in:
GochoMugo 2017-12-21 12:43:56 +03:00
parent 309696622d
commit 2bdd50fdc2
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
3 changed files with 161 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -25,6 +25,7 @@ Changed:
1. Update *TelegramBot#answerCallbackQuery()* signature (by @GochoMugo) 1. Update *TelegramBot#answerCallbackQuery()* signature (by @GochoMugo)
1. Improve default error logging of `polling_error` and `webhook_error` (#377) 1. Improve default error logging of `polling_error` and `webhook_error` (#377)
1. Update dependencies
Deprecated: Deprecated:

264
doc/api.md
View File

@ -105,13 +105,13 @@ Emits `message` when a message arrives.
| --- | --- | --- | --- | | --- | --- | --- | --- |
| token | <code>String</code> | | Bot Token | | token | <code>String</code> | | Bot Token |
| [options] | <code>Object</code> | | | | [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] | <code>Boolean</code> \| <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> | *Deprecated. Use `options.polling.params` instead*. Timeout in seconds for long polling. | | [options.polling.timeout] | <code>String</code> \| <code>Number</code> | <code>10</code> | *Deprecated. Use `options.polling.params` instead*. 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.interval] | <code>String</code> \| <code>Number</code> | <code>300</code> | Interval between requests in miliseconds |
| [options.polling.autoStart] | <code>Boolean</code> | <code>true</code> | Start polling immediately | | [options.polling.autoStart] | <code>Boolean</code> | <code>true</code> | Start polling immediately |
| [options.polling.params] | <code>Object</code> | | Parameters to be used in polling API requests. See https://core.telegram.org/bots/api#getupdates for more information. | | [options.polling.params] | <code>Object</code> | | Parameters to be used in polling API requests. See https://core.telegram.org/bots/api#getupdates for more information. |
| [options.polling.params.timeout] | <code>Number</code> | <code>10</code> | Timeout in seconds for long polling. | | [options.polling.params.timeout] | <code>Number</code> | <code>10</code> | Timeout in seconds for long polling. |
| [options.webHook] | <code>Boolean</code> &#124; <code>Object</code> | <code>false</code> | Set true to enable WebHook or set options | | [options.webHook] | <code>Boolean</code> \| <code>Object</code> | <code>false</code> | Set true to enable WebHook or set options |
| [options.webHook.host] | <code>String</code> | <code>&quot;0.0.0.0&quot;</code> | Host to bind to | | [options.webHook.host] | <code>String</code> | <code>&quot;0.0.0.0&quot;</code> | Host to bind to |
| [options.webHook.port] | <code>Number</code> | <code>8443</code> | Port to bind to | | [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.key] | <code>String</code> | | Path to file with PEM private key for webHook server. The file is read **synchronously**! |
@ -132,7 +132,7 @@ Emits `message` when a message arrives.
Add listener for the specified [event](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#events). Add listener for the specified [event](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#events).
This is the usual `emitter.on()` method. This is the usual `emitter.on()` method.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- [Available events](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#events) - [Available events](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#events)
@ -150,7 +150,7 @@ This is the usual `emitter.on()` method.
Start polling. Start polling.
Rejects returned promise if a WebHook is being used by this instance. Rejects returned promise if a WebHook is being used by this instance.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
@ -164,7 +164,7 @@ Rejects returned promise if a WebHook is being used by this instance.
Alias of `TelegramBot#startPolling()`. This is **deprecated**. Alias of `TelegramBot#startPolling()`. This is **deprecated**.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | | Param | Type |
| --- | --- | | --- | --- |
@ -177,7 +177,7 @@ Stops polling after the last polling request resolves.
Multiple invocations do nothing if polling is already stopped. Multiple invocations do nothing if polling is already stopped.
Returning the promise of the last polling request is **deprecated**. Returning the promise of the last polling request is **deprecated**.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
@ -190,7 +190,7 @@ Returning the promise of the last polling request is **deprecated**.
### telegramBot.isPolling() ⇒ <code>Boolean</code> ### telegramBot.isPolling() ⇒ <code>Boolean</code>
Return true if polling. Otherwise, false. Return true if polling. Otherwise, false.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot+openWebHook"></a> <a name="TelegramBot+openWebHook"></a>
### telegramBot.openWebHook() ⇒ <code>Promise</code> ### telegramBot.openWebHook() ⇒ <code>Promise</code>
@ -198,14 +198,14 @@ Open webhook.
Multiple invocations do nothing if webhook is already open. Multiple invocations do nothing if webhook is already open.
Rejects returned promise if Polling is being used by this instance. Rejects returned promise if Polling is being used by this instance.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot+closeWebHook"></a> <a name="TelegramBot+closeWebHook"></a>
### telegramBot.closeWebHook() ⇒ <code>Promise</code> ### telegramBot.closeWebHook() ⇒ <code>Promise</code>
Close webhook after closing all current connections. Close webhook after closing all current connections.
Multiple invocations do nothing if webhook is already closed. Multiple invocations do nothing if webhook is already closed.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Promise</code> - promise **Returns**: <code>Promise</code> - promise
<a name="TelegramBot+hasOpenWebHook"></a> <a name="TelegramBot+hasOpenWebHook"></a>
@ -213,13 +213,13 @@ Multiple invocations do nothing if webhook is already closed.
Return true if using webhook and it is open i.e. accepts connections. Return true if using webhook and it is open i.e. accepts connections.
Otherwise, false. Otherwise, false.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot+getMe"></a> <a name="TelegramBot+getMe"></a>
### telegramBot.getMe([options]) ⇒ <code>Promise</code> ### telegramBot.getMe([options]) ⇒ <code>Promise</code>
Returns basic information about the bot in form of a `User` object. Returns basic information about the bot in form of a `User` object.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getme **See**: https://core.telegram.org/bots/api#getme
| Param | Type | Description | | Param | Type | Description |
@ -233,7 +233,7 @@ Specify an url to receive incoming updates via an outgoing webHook.
This method has an [older, compatible signature][setWebHook-v0.25.0] This method has an [older, compatible signature][setWebHook-v0.25.0]
that is being deprecated. that is being deprecated.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#setwebhook - https://core.telegram.org/bots/api#setwebhook
@ -244,7 +244,7 @@ that is being deprecated.
| --- | --- | --- | | --- | --- | --- |
| url | <code>String</code> | URL where Telegram will make HTTP Post. Leave empty to delete webHook. | | 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] | <code>Object</code> | Additional Telegram query options |
| [options.certificate] | <code>String</code> &#124; <code>stream.Stream</code> | PEM certificate key (public). | | [options.certificate] | <code>String</code> \| <code>stream.Stream</code> | PEM certificate key (public). |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
<a name="TelegramBot+deleteWebHook"></a> <a name="TelegramBot+deleteWebHook"></a>
@ -253,7 +253,7 @@ that is being deprecated.
Use this method to remove webhook integration if you decide to Use this method to remove webhook integration if you decide to
switch back to getUpdates. Returns True on success. switch back to getUpdates. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#deletewebhook **See**: https://core.telegram.org/bots/api#deletewebhook
| Param | Type | Description | | Param | Type | Description |
@ -268,7 +268,7 @@ On success, returns a [WebhookInfo](https://core.telegram.org/bots/api#webhookin
If the bot is using getUpdates, will return an object with the If the bot is using getUpdates, will return an object with the
url field empty. url field empty.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getwebhookinfo **See**: https://core.telegram.org/bots/api#getwebhookinfo
| Param | Type | Description | | Param | Type | Description |
@ -282,7 +282,7 @@ Use this method to receive incoming updates using long polling.
This method has an [older, compatible signature][getUpdates-v0.25.0] This method has an [older, compatible signature][getUpdates-v0.25.0]
that is being deprecated. that is being deprecated.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getupdates **See**: https://core.telegram.org/bots/api#getupdates
| Param | Type | Description | | Param | Type | Description |
@ -296,7 +296,7 @@ Process an update; emitting the proper events and executing regexp
callbacks. This method is useful should you be using a different callbacks. This method is useful should you be using a different
way to fetch updates, other than those provided by TelegramBot. way to fetch updates, other than those provided by TelegramBot.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#update **See**: https://core.telegram.org/bots/api#update
| Param | Type | | Param | Type |
@ -308,12 +308,12 @@ way to fetch updates, other than those provided by TelegramBot.
### telegramBot.sendMessage(chatId, text, [options]) ⇒ <code>Promise</code> ### telegramBot.sendMessage(chatId, text, [options]) ⇒ <code>Promise</code>
Send text message. Send text message.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendmessage **See**: https://core.telegram.org/bots/api#sendmessage
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| text | <code>String</code> | Text of the message to be sent | | text | <code>String</code> | Text of the message to be sent |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -322,7 +322,7 @@ Send text message.
### telegramBot.answerInlineQuery(inlineQueryId, results, [options]) ⇒ <code>Promise</code> ### telegramBot.answerInlineQuery(inlineQueryId, results, [options]) ⇒ <code>Promise</code>
Send answers to an inline query. Send answers to an inline query.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#answerinlinequery **See**: https://core.telegram.org/bots/api#answerinlinequery
| Param | Type | Description | | Param | Type | Description |
@ -336,13 +336,13 @@ Send answers to an inline query.
### telegramBot.forwardMessage(chatId, fromChatId, messageId, [options]) ⇒ <code>Promise</code> ### telegramBot.forwardMessage(chatId, fromChatId, messageId, [options]) ⇒ <code>Promise</code>
Forward messages of any kind. Forward messages of any kind.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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 | | fromChatId | <code>Number</code> \| <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 | | messageId | <code>Number</code> \| <code>String</code> | Unique message identifier |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+sendPhoto"></a> <a name="TelegramBot+sendPhoto"></a>
@ -350,7 +350,7 @@ Forward messages of any kind.
### telegramBot.sendPhoto(chatId, photo, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendPhoto(chatId, photo, [options], [fileOptions]) ⇒ <code>Promise</code>
Send photo Send photo
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendphoto - https://core.telegram.org/bots/api#sendphoto
@ -359,8 +359,8 @@ Send photo
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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 | | photo | <code>String</code> \| <code>stream.Stream</code> \| <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 | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -369,7 +369,7 @@ Send photo
### telegramBot.sendAudio(chatId, audio, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendAudio(chatId, audio, [options], [fileOptions]) ⇒ <code>Promise</code>
Send audio Send audio
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendaudio - https://core.telegram.org/bots/api#sendaudio
@ -378,8 +378,8 @@ Send audio
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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. | | audio | <code>String</code> \| <code>stream.Stream</code> \| <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 | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -388,7 +388,7 @@ Send audio
### telegramBot.sendDocument(chatId, doc, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendDocument(chatId, doc, [options], [fileOptions]) ⇒ <code>Promise</code>
Send Document Send Document
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendDocument - https://core.telegram.org/bots/api#sendDocument
@ -397,8 +397,8 @@ Send Document
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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. | | doc | <code>String</code> \| <code>stream.Stream</code> \| <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 | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -407,13 +407,13 @@ Send Document
### telegramBot.sendSticker(chatId, sticker, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendSticker(chatId, sticker, [options], [fileOptions]) ⇒ <code>Promise</code>
Send .webp stickers. Send .webp stickers.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendsticker **See**: https://core.telegram.org/bots/api#sendsticker
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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. | | sticker | <code>String</code> \| <code>stream.Stream</code> \| <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 | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -422,7 +422,7 @@ Send .webp stickers.
### telegramBot.sendVideo(chatId, video, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendVideo(chatId, video, [options], [fileOptions]) ⇒ <code>Promise</code>
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). 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> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendvideo - https://core.telegram.org/bots/api#sendvideo
@ -431,8 +431,8 @@ Use this method to send video files, Telegram clients support mp4 videos (other
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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. | | video | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | A file path or Stream. Can also be a `file_id` previously uploaded. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -441,7 +441,7 @@ Use this method to send video files, Telegram clients support mp4 videos (other
### telegramBot.sendVideoNote(chatId, videoNote, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendVideoNote(chatId, videoNote, [options], [fileOptions]) ⇒ <code>Promise</code>
Use this method to send rounded square videos of upto 1 minute long. Use this method to send rounded square videos of upto 1 minute long.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Info**: The length parameter is actually optional. However, the API (at time of writing) requires you to always provide it until it is fixed. **Info**: The length parameter is actually optional. However, the API (at time of writing) requires you to always provide it until it is fixed.
**See** **See**
@ -451,8 +451,8 @@ Use this method to send rounded square videos of upto 1 minute long.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| videoNote | <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. | | videoNote | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | A file path or Stream. Can also be a `file_id` previously uploaded. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -461,7 +461,7 @@ Use this method to send rounded square videos of upto 1 minute long.
### telegramBot.sendVoice(chatId, voice, [options], [fileOptions]) ⇒ <code>Promise</code> ### telegramBot.sendVoice(chatId, voice, [options], [fileOptions]) ⇒ <code>Promise</code>
Send voice Send voice
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendvoice - https://core.telegram.org/bots/api#sendvoice
@ -470,8 +470,8 @@ Send voice
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <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. | | voice | <code>String</code> \| <code>stream.Stream</code> \| <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 | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -484,12 +484,12 @@ Send chat action.
`record_audio` or `upload_audio` for audio files, `upload_document` for general files, `record_audio` or `upload_audio` for audio files, `upload_document` for general files,
`find_location` for location data. `find_location` for location data.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendchataction **See**: https://core.telegram.org/bots/api#sendchataction
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| action | <code>String</code> | Type of action to broadcast. | | action | <code>String</code> | Type of action to broadcast. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -502,12 +502,12 @@ 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. first. The bot must be an administrator in the group for this to work.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#kickchatmember **See**: https://core.telegram.org/bots/api#kickchatmember
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>Number</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -519,12 +519,12 @@ 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 able to join via link, etc. The bot must be an administrator in
the group for this to work. Returns True on success. the group for this to work. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#unbanchatmember **See**: https://core.telegram.org/bots/api#unbanchatmember
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>Number</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -536,12 +536,12 @@ The bot must be an administrator in the supergroup for this to work
and must have the appropriate admin rights. Pass True for all boolean parameters and must have the appropriate admin rights. Pass True for all boolean parameters
to lift restrictions from a user. Returns True on success. to lift restrictions from a user. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#restrictchatmember **See**: https://core.telegram.org/bots/api#restrictchatmember
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target chat or username of the target supergroup |
| userId | <code>Number</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -553,12 +553,12 @@ The bot must be an administrator in the chat for this to work
and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#promotechatmember **See**: https://core.telegram.org/bots/api#promotechatmember
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target chat or username of the target supergroup |
| userId | <code>Number</code> | | | userId | <code>Number</code> | |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -569,12 +569,12 @@ Use this method to export an invite link to a supergroup or a channel.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns exported invite link as String on success. Returns exported invite link as String on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#exportchatinvitelink **See**: https://core.telegram.org/bots/api#exportchatinvitelink
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target chat or username of the target supergroup |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+setChatPhoto"></a> <a name="TelegramBot+setChatPhoto"></a>
@ -584,13 +584,13 @@ Use this method to set a new profile photo for the chat. Photos can't be changed
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setchatphoto **See**: https://core.telegram.org/bots/api#setchatphoto
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| photo | <code>stream.Stream</code> &#124; <code>Buffer</code> | A file path or a Stream. | | photo | <code>stream.Stream</code> \| <code>Buffer</code> | A file path or a Stream. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -601,12 +601,12 @@ Use this method to delete a chat photo. Photos can't be changed for private chat
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#deletechatphoto **See**: https://core.telegram.org/bots/api#deletechatphoto
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+setChatTitle"></a> <a name="TelegramBot+setChatTitle"></a>
@ -616,12 +616,12 @@ Use this method to change the title of a chat. Titles can't be changed for priva
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setchattitle **See**: https://core.telegram.org/bots/api#setchattitle
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| title | <code>String</code> | New chat title, 1-255 characters | | title | <code>String</code> | New chat title, 1-255 characters |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -632,12 +632,12 @@ Use this method to change the description of a supergroup or a channel.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setchatdescription **See**: https://core.telegram.org/bots/api#setchatdescription
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| description | <code>String</code> | New chat title, 1-255 characters | | description | <code>String</code> | New chat title, 1-255 characters |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -648,12 +648,12 @@ Use this method to pin a message in a supergroup.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#pinchatmessage **See**: https://core.telegram.org/bots/api#pinchatmessage
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| messageId | <code>String</code> | Identifier of a message to pin | | messageId | <code>String</code> | Identifier of a message to pin |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -664,12 +664,12 @@ Use this method to unpin a message in a supergroup chat.
The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#unpinchatmessage **See**: https://core.telegram.org/bots/api#unpinchatmessage
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+answerCallbackQuery"></a> <a name="TelegramBot+answerCallbackQuery"></a>
@ -683,7 +683,7 @@ On success, True is returned.
This method has **older, compatible signatures ([1][answerCallbackQuery-v0.27.1])([2][answerCallbackQuery-v0.29.0])** This method has **older, compatible signatures ([1][answerCallbackQuery-v0.27.1])([2][answerCallbackQuery-v0.29.0])**
that are being deprecated. that are being deprecated.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#answercallbackquery **See**: https://core.telegram.org/bots/api#answercallbackquery
| Param | Type | Description | | Param | Type | Description |
@ -701,7 +701,7 @@ returned.
Note that you must provide one of chat_id, message_id, or Note that you must provide one of chat_id, message_id, or
inline_message_id in your request. inline_message_id in your request.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#editmessagetext **See**: https://core.telegram.org/bots/api#editmessagetext
| Param | Type | Description | | Param | Type | Description |
@ -719,7 +719,7 @@ edited Message is returned.
Note that you must provide one of chat_id, message_id, or Note that you must provide one of chat_id, message_id, or
inline_message_id in your request. inline_message_id in your request.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#editmessagecaption **See**: https://core.telegram.org/bots/api#editmessagecaption
| Param | Type | Description | | Param | Type | Description |
@ -737,7 +737,7 @@ On success, the edited Message is returned.
Note that you must provide one of chat_id, message_id, or Note that you must provide one of chat_id, message_id, or
inline_message_id in your request. inline_message_id in your request.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#editmessagetext **See**: https://core.telegram.org/bots/api#editmessagetext
| Param | Type | Description | | Param | Type | Description |
@ -753,7 +753,7 @@ Returns a [UserProfilePhotos](https://core.telegram.org/bots/api#userprofilephot
This method has an [older, compatible signature][getUserProfilePhotos-v0.25.0] This method has an [older, compatible signature][getUserProfilePhotos-v0.25.0]
that is being deprecated. that is being deprecated.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getuserprofilephotos **See**: https://core.telegram.org/bots/api#getuserprofilephotos
| Param | Type | Description | | Param | Type | Description |
@ -767,12 +767,12 @@ that is being deprecated.
Send location. Send location.
Use this method to send point on the map. Use this method to send point on the map.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendlocation **See**: https://core.telegram.org/bots/api#sendlocation
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| latitude | <code>Float</code> | Latitude of location | | latitude | <code>Float</code> | Latitude of location |
| longitude | <code>Float</code> | Longitude of location | | longitude | <code>Float</code> | Longitude of location |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -786,7 +786,7 @@ the bot or via the bot (for inline bots).
Note that you must provide one of chat_id, message_id, or Note that you must provide one of chat_id, message_id, or
inline_message_id in your request. inline_message_id in your request.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#editmessagelivelocation **See**: https://core.telegram.org/bots/api#editmessagelivelocation
| Param | Type | Description | | Param | Type | Description |
@ -804,7 +804,7 @@ the bot or via the bot (for inline bots) before live_period expires.
Note that you must provide one of chat_id, message_id, or Note that you must provide one of chat_id, message_id, or
inline_message_id in your request. inline_message_id in your request.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#stopmessagelivelocation **See**: https://core.telegram.org/bots/api#stopmessagelivelocation
| Param | Type | Description | | Param | Type | Description |
@ -817,12 +817,12 @@ inline_message_id in your request.
Send venue. Send venue.
Use this method to send information about a venue. Use this method to send information about a venue.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendvenue **See**: https://core.telegram.org/bots/api#sendvenue
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| latitude | <code>Float</code> | Latitude of location | | latitude | <code>Float</code> | Latitude of location |
| longitude | <code>Float</code> | Longitude of location | | longitude | <code>Float</code> | Longitude of location |
| title | <code>String</code> | Name of the venue | | title | <code>String</code> | Name of the venue |
@ -835,12 +835,12 @@ Use this method to send information about a venue.
Send contact. Send contact.
Use this method to send phone contacts. Use this method to send phone contacts.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendcontact **See**: https://core.telegram.org/bots/api#sendcontact
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| phoneNumber | <code>String</code> | Contact's phone number | | phoneNumber | <code>String</code> | Contact's phone number |
| firstName | <code>String</code> | Contact's first name | | firstName | <code>String</code> | Contact's first name |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -852,7 +852,7 @@ Get file.
Use this method to get basic info about a file and prepare it for downloading. Use this method to get basic info about a file and prepare it for downloading.
Attention: link will be valid for 1 hour. Attention: link will be valid for 1 hour.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getfile **See**: https://core.telegram.org/bots/api#getfile
| Param | Type | Description | | Param | Type | Description |
@ -870,7 +870,7 @@ Attention: link will be valid for 1 hour.
This method is a sugar extension of the (getFile)[#getfilefileid] method, 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). 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> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Promise</code> - promise Promise which will have *fileURI* in resolve callback **Returns**: <code>Promise</code> - promise Promise which will have *fileURI* in resolve callback
**See**: https://core.telegram.org/bots/api#getfile **See**: https://core.telegram.org/bots/api#getfile
@ -892,7 +892,7 @@ file on Telegram servers.
This method is a sugar extension of the [getFileLink](#TelegramBot+getFileLink) method, This method is a sugar extension of the [getFileLink](#TelegramBot+getFileLink) method,
which returns the full URI to the file on remote server. which returns the full URI to the file on remote server.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>stream.Readable</code> - fileStream **Returns**: <code>stream.Readable</code> - fileStream
| Param | Type | Description | | Param | Type | Description |
@ -908,7 +908,7 @@ Downloads file in the specified folder.
This method is a sugar extension of the [getFileStream](#TelegramBot+getFileStream) method, This method is a sugar extension of the [getFileStream](#TelegramBot+getFileStream) method,
which returns a readable file stream. which returns a readable file stream.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Promise</code> - promise Promise, which will have *filePath* of downloaded file in resolve callback **Returns**: <code>Promise</code> - promise Promise, which will have *filePath* of downloaded file in resolve callback
| Param | Type | Description | | Param | Type | Description |
@ -922,7 +922,7 @@ which returns a readable file stream.
### telegramBot.onText(regexp, callback) ### telegramBot.onText(regexp, callback)
Register a RegExp to test against an incomming text message. Register a RegExp to test against an incomming text message.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
@ -934,7 +934,7 @@ Register a RegExp to test against an incomming text message.
### telegramBot.removeTextListener(regexp) ⇒ <code>Object</code> ### telegramBot.removeTextListener(regexp) ⇒ <code>Object</code>
Remove a listener registered with `onText()`. Remove a listener registered with `onText()`.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Object</code> - deletedListener The removed reply listener if **Returns**: <code>Object</code> - deletedListener The removed reply listener if
found. This object has `regexp` and `callback` found. This object has `regexp` and `callback`
properties. If not found, returns `null`. properties. If not found, returns `null`.
@ -948,13 +948,13 @@ Remove a listener registered with `onText()`.
### telegramBot.onReplyToMessage(chatId, messageId, callback) ⇒ <code>Number</code> ### telegramBot.onReplyToMessage(chatId, messageId, callback) ⇒ <code>Number</code>
Register a reply to wait for a message response. Register a reply to wait for a message response.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Number</code> - id The ID of the inserted reply listener. **Returns**: <code>Number</code> - id The ID of the inserted reply listener.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | The chat id where the message cames from. | | chatId | <code>Number</code> \| <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. | | 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. | | callback | <code>function</code> | Callback will be called with the reply message. |
<a name="TelegramBot+removeReplyListener"></a> <a name="TelegramBot+removeReplyListener"></a>
@ -962,7 +962,7 @@ Register a reply to wait for a message response.
### telegramBot.removeReplyListener(replyListenerId) ⇒ <code>Object</code> ### telegramBot.removeReplyListener(replyListenerId) ⇒ <code>Object</code>
Removes a reply that has been prev. registered for a message response. Removes a reply that has been prev. registered for a message response.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**Returns**: <code>Object</code> - deletedListener The removed reply listener if **Returns**: <code>Object</code> - deletedListener The removed reply listener if
found. This object has `id`, `chatId`, `messageId` and `callback` found. This object has `id`, `chatId`, `messageId` and `callback`
properties. If not found, returns `null`. properties. If not found, returns `null`.
@ -978,12 +978,12 @@ Use this method to get up to date information about the chat
(current name of the user for one-on-one conversations, current (current name of the user for one-on-one conversations, current
username of a user, group or channel, etc.). username of a user, group or channel, etc.).
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getchat **See**: https://core.telegram.org/bots/api#getchat
| Param | Type | Description | | 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 | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target chat or username of the target supergroup or channel |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+getChatAdministrators"></a> <a name="TelegramBot+getChatAdministrators"></a>
@ -991,12 +991,12 @@ username of a user, group or channel, etc.).
### telegramBot.getChatAdministrators(chatId, [options]) ⇒ <code>Promise</code> ### telegramBot.getChatAdministrators(chatId, [options]) ⇒ <code>Promise</code>
Returns the administrators in a chat in form of an Array of `ChatMember` objects. Returns the administrators in a chat in form of an Array of `ChatMember` objects.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getchatadministrators **See**: https://core.telegram.org/bots/api#getchatadministrators
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+getChatMembersCount"></a> <a name="TelegramBot+getChatMembersCount"></a>
@ -1004,12 +1004,12 @@ Returns the administrators in a chat in form of an Array of `ChatMember` objects
### telegramBot.getChatMembersCount(chatId, [options]) ⇒ <code>Promise</code> ### telegramBot.getChatMembersCount(chatId, [options]) ⇒ <code>Promise</code>
Use this method to get the number of members in a chat. Use this method to get the number of members in a chat.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getchatmemberscount **See**: https://core.telegram.org/bots/api#getchatmemberscount
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+getChatMember"></a> <a name="TelegramBot+getChatMember"></a>
@ -1017,12 +1017,12 @@ Use this method to get the number of members in a chat.
### telegramBot.getChatMember(chatId, userId, [options]) ⇒ <code>Promise</code> ### telegramBot.getChatMember(chatId, userId, [options]) ⇒ <code>Promise</code>
Use this method to get information about a member of a chat. Use this method to get information about a member of a chat.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getchatmember **See**: https://core.telegram.org/bots/api#getchatmember
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>Number</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -1031,12 +1031,12 @@ Use this method to get information about a member of a chat.
### telegramBot.leaveChat(chatId, [options]) ⇒ <code>Promise</code> ### telegramBot.leaveChat(chatId, [options]) ⇒ <code>Promise</code>
Leave a group, supergroup or channel. Leave a group, supergroup or channel.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#leavechat **See**: https://core.telegram.org/bots/api#leavechat
| Param | Type | Description | | 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) | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+setChatStickerSet"></a> <a name="TelegramBot+setChatStickerSet"></a>
@ -1044,12 +1044,12 @@ Leave a group, supergroup or channel.
### telegramBot.setChatStickerSet(chatId, stickerSetName, [options]) ⇒ <code>Promise</code> ### telegramBot.setChatStickerSet(chatId, stickerSetName, [options]) ⇒ <code>Promise</code>
Use this method to set a new group sticker set for a supergroup. Use this method to set a new group sticker set for a supergroup.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setchatstickerset **See**: https://core.telegram.org/bots/api#setchatstickerset
| Param | Type | Description | | 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) | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) |
| stickerSetName | <code>String</code> | Name of the sticker set to be set as the group sticker set | | stickerSetName | <code>String</code> | Name of the sticker set to be set as the group sticker set |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -1058,12 +1058,12 @@ Use this method to set a new group sticker set for a supergroup.
### telegramBot.deleteChatStickerSet(chatId, [options]) ⇒ <code>Promise</code> ### telegramBot.deleteChatStickerSet(chatId, [options]) ⇒ <code>Promise</code>
Use this method to delete a group sticker set from a supergroup. Use this method to delete a group sticker set from a supergroup.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#deletechatstickerset **See**: https://core.telegram.org/bots/api#deletechatstickerset
| Param | Type | Description | | 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) | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+sendGame"></a> <a name="TelegramBot+sendGame"></a>
@ -1071,12 +1071,12 @@ Use this method to delete a group sticker set from a supergroup.
### telegramBot.sendGame(chatId, gameShortName, [options]) ⇒ <code>Promise</code> ### telegramBot.sendGame(chatId, gameShortName, [options]) ⇒ <code>Promise</code>
Use this method to send a game. Use this method to send a game.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendgame **See**: https://core.telegram.org/bots/api#sendgame
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| gameShortName | <code>String</code> | name of the game to be sent. | | gameShortName | <code>String</code> | name of the game to be sent. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -1085,7 +1085,7 @@ Use this method to send a game.
### telegramBot.setGameScore(userId, score, [options]) ⇒ <code>Promise</code> ### telegramBot.setGameScore(userId, score, [options]) ⇒ <code>Promise</code>
Use this method to set the score of the specified user in a game. Use this method to set the score of the specified user in a game.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setgamescore **See**: https://core.telegram.org/bots/api#setgamescore
| Param | Type | Description | | Param | Type | Description |
@ -1099,7 +1099,7 @@ Use this method to set the score of the specified user in a game.
### telegramBot.getGameHighScores(userId, [options]) ⇒ <code>Promise</code> ### telegramBot.getGameHighScores(userId, [options]) ⇒ <code>Promise</code>
Use this method to get data for high score table. Use this method to get data for high score table.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getgamehighscores **See**: https://core.telegram.org/bots/api#getgamehighscores
| Param | Type | Description | | Param | Type | Description |
@ -1112,12 +1112,12 @@ Use this method to get data for high score table.
### telegramBot.deleteMessage(chatId, messageId, [options]) ⇒ <code>Promise</code> ### telegramBot.deleteMessage(chatId, messageId, [options]) ⇒ <code>Promise</code>
Use this method to delete a message. Use this method to delete a message.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#deletemessage **See**: https://core.telegram.org/bots/api#deletemessage
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier of the target chat | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier of the target chat |
| messageId | <code>String</code> | Unique identifier of the target message | | messageId | <code>String</code> | Unique identifier of the target message |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -1127,12 +1127,12 @@ Use this method to delete a message.
Send invoice. Send invoice.
Use this method to send an invoice. Use this method to send an invoice.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#sendinvoice **See**: https://core.telegram.org/bots/api#sendinvoice
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the message recipient | | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
| title | <code>String</code> | Product name | | title | <code>String</code> | Product name |
| description | <code>String</code> | product description | | description | <code>String</code> | product description |
| payload | <code>String</code> | Bot defined invoice payload | | payload | <code>String</code> | Bot defined invoice payload |
@ -1148,7 +1148,7 @@ Use this method to send an invoice.
Answer shipping query.. Answer shipping query..
Use this method to reply to shipping queries. Use this method to reply to shipping queries.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#answershippingquery **See**: https://core.telegram.org/bots/api#answershippingquery
| Param | Type | Description | | Param | Type | Description |
@ -1163,7 +1163,7 @@ Use this method to reply to shipping queries.
Answer pre-checkout query. Answer pre-checkout query.
Use this method to confirm shipping of a product. Use this method to confirm shipping of a product.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#answerprecheckoutquery **See**: https://core.telegram.org/bots/api#answerprecheckoutquery
| Param | Type | Description | | Param | Type | Description |
@ -1177,7 +1177,7 @@ Use this method to confirm shipping of a product.
### telegramBot.getStickerSet(name, [options]) ⇒ <code>Promise</code> ### telegramBot.getStickerSet(name, [options]) ⇒ <code>Promise</code>
Use this method to get a sticker set. On success, a [StickerSet](https://core.telegram.org/bots/api#stickerset) object is returned. Use this method to get a sticker set. On success, a [StickerSet](https://core.telegram.org/bots/api#stickerset) object is returned.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#getstickerset **See**: https://core.telegram.org/bots/api#getstickerset
| Param | Type | Description | | Param | Type | Description |
@ -1191,13 +1191,13 @@ Use this method to get a sticker set. On success, a [StickerSet](https://core.te
Use this method to upload a .png file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple Use this method to upload a .png file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple
times). Returns the uploaded [File](https://core.telegram.org/bots/api#file) on success. times). Returns the uploaded [File](https://core.telegram.org/bots/api#file) on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#uploadstickerfile **See**: https://core.telegram.org/bots/api#uploadstickerfile
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| userId | <code>Number</code> | User identifier of sticker file owner | | userId | <code>Number</code> | User identifier of sticker file owner |
| pngSticker | <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. **Png** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. | | pngSticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | A file path or a Stream. Can also be a `file_id` previously uploaded. **Png** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -1208,7 +1208,7 @@ Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set. The bot will be able to edit the created sticker set.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#createnewstickerset **See**: https://core.telegram.org/bots/api#createnewstickerset
**Todo** **Todo**
@ -1220,7 +1220,7 @@ Returns True on success.
| userId | <code>Number</code> | User identifier of created sticker set owner | | userId | <code>Number</code> | User identifier of created sticker set owner |
| name | <code>String</code> | Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g., *animals*) | | name | <code>String</code> | Short name of sticker set, to be used in `t.me/addstickers/` URLs (e.g., *animals*) |
| title | <code>String</code> | Sticker set title, 1-64 characters | | title | <code>String</code> | Sticker set title, 1-64 characters |
| pngSticker | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. | | pngSticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. |
| emojis | <code>String</code> | One or more emoji corresponding to the sticker | | emojis | <code>String</code> | One or more emoji corresponding to the sticker |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -1231,7 +1231,7 @@ Returns True on success.
Use this method to add a new sticker to a set created by the bot. Use this method to add a new sticker to a set created by the bot.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#addstickertoset **See**: https://core.telegram.org/bots/api#addstickertoset
**Todo** **Todo**
@ -1242,7 +1242,7 @@ Returns True on success.
| --- | --- | --- | | --- | --- | --- |
| userId | <code>Number</code> | User identifier of sticker set owner | | userId | <code>Number</code> | User identifier of sticker set owner |
| name | <code>String</code> | Sticker set name | | name | <code>String</code> | Sticker set name |
| pngSticker | <code>String</code> &#124; <code>stream.Stream</code> &#124; <code>Buffer</code> | Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px | | pngSticker | <code>String</code> \| <code>stream.Stream</code> \| <code>Buffer</code> | Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px |
| emojis | <code>String</code> | One or more emoji corresponding to the sticker | | emojis | <code>String</code> | One or more emoji corresponding to the sticker |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
| [fileOptions] | <code>Object</code> | Optional file related meta-data | | [fileOptions] | <code>Object</code> | Optional file related meta-data |
@ -1253,7 +1253,7 @@ Returns True on success.
Use this method to move a sticker in a set created by the bot to a specific position. Use this method to move a sticker in a set created by the bot to a specific position.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#setstickerpositioninset **See**: https://core.telegram.org/bots/api#setstickerpositioninset
**Todo** **Todo**
@ -1272,7 +1272,7 @@ Returns True on success.
Use this method to delete a sticker from a set created by the bot. Use this method to delete a sticker from a set created by the bot.
Returns True on success. Returns True on success.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See**: https://core.telegram.org/bots/api#deletestickerfromset **See**: https://core.telegram.org/bots/api#deletestickerfromset
**Todo** **Todo**
@ -1294,7 +1294,7 @@ is returned.
If you wish to [specify file options](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#sending-files), If you wish to [specify file options](https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#sending-files),
add a `fileOptions` property to the target input in `media`. add a `fileOptions` property to the target input in `media`.
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code> **Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
**See** **See**
- https://core.telegram.org/bots/api#sendmediagroup - https://core.telegram.org/bots/api#sendmediagroup
@ -1312,20 +1312,20 @@ add a `fileOptions` property to the target input in `media`.
### TelegramBot.errors : <code>Object</code> ### TelegramBot.errors : <code>Object</code>
The different errors the library uses. The different errors the library uses.
**Kind**: static property of <code>[TelegramBot](#TelegramBot)</code> **Kind**: static property of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot.messageTypes"></a> <a name="TelegramBot.messageTypes"></a>
### TelegramBot.messageTypes : <code>Array.&lt;String&gt;</code> ### TelegramBot.messageTypes : <code>Array.&lt;String&gt;</code>
The types of message updates the library handles. The types of message updates the library handles.
**Kind**: static property of <code>[TelegramBot](#TelegramBot)</code> **Kind**: static property of [<code>TelegramBot</code>](#TelegramBot)
<a name="TelegramBot.Promise"></a> <a name="TelegramBot.Promise"></a>
### TelegramBot.Promise ### TelegramBot.Promise
Change Promise library used internally, for all existing and new Change Promise library used internally, for all existing and new
instances. instances.
**Kind**: static property of <code>[TelegramBot](#TelegramBot)</code> **Kind**: static property of [<code>TelegramBot</code>](#TelegramBot)
| Param | Type | | Param | Type |
| --- | --- | | --- | --- |

56
package.json
View File

@ -29,42 +29,42 @@
"node": ">=0.12" "node": ">=0.12"
}, },
"dependencies": { "dependencies": {
"array.prototype.findindex": "^2.0.0", "array.prototype.findindex": "^2.0.2",
"bl": "^1.1.2", "bl": "^1.2.1",
"bluebird": "^3.3.4", "bluebird": "^3.5.1",
"debug": "^2.2.0", "debug": "^3.1.0",
"depd": "^1.1.0", "depd": "^1.1.1",
"eventemitter3": "^2.0.2", "eventemitter3": "^3.0.0",
"file-type": "^3.9.0", "file-type": "^3.9.0",
"mime": "^1.3.4", "mime": "^1.6.0",
"pump": "^1.0.1", "pump": "^2.0.0",
"request": "^2.69.0", "request": "^2.83.0",
"request-promise": "^4.1.1" "request-promise": "^4.2.2"
}, },
"devDependencies": { "devDependencies": {
"babel-cli": "^6.6.5", "babel-cli": "^6.26.0",
"babel-eslint": "^6.1.2", "babel-eslint": "^8.0.3",
"babel-plugin-transform-class-properties": "^6.6.0", "babel-plugin-transform-class-properties": "^6.24.1",
"babel-plugin-transform-es2015-destructuring": "^6.6.5", "babel-plugin-transform-es2015-destructuring": "^6.23.0",
"babel-plugin-transform-es2015-parameters": "^6.7.0", "babel-plugin-transform-es2015-parameters": "^6.24.1",
"babel-plugin-transform-es2015-shorthand-properties": "^6.5.0", "babel-plugin-transform-es2015-shorthand-properties": "^6.24.1",
"babel-plugin-transform-es2015-spread": "^6.6.5", "babel-plugin-transform-es2015-spread": "^6.22.0",
"babel-plugin-transform-object-rest-spread": "^6.6.5", "babel-plugin-transform-object-rest-spread": "^6.26.0",
"babel-plugin-transform-strict-mode": "^6.6.5", "babel-plugin-transform-strict-mode": "^6.24.1",
"babel-preset-es2015": "^6.6.0", "babel-preset-es2015": "^6.24.1",
"babel-register": "^6.7.2", "babel-register": "^6.26.0",
"concat-stream": "^1.6.0", "concat-stream": "^1.6.0",
"contributor": "^0.1.25", "contributor": "^0.1.25",
"eslint": "^2.13.1", "eslint": "^4.13.1",
"eslint-config-airbnb": "^6.2.0", "eslint-config-airbnb": "^6.2.0",
"eslint-plugin-mocha": "^4.8.0", "eslint-plugin-mocha": "^4.11.0",
"is": "^3.1.0", "is": "^3.2.1",
"is-ci": "^1.0.10", "is-ci": "^1.0.10",
"istanbul": "^1.1.0-alpha.1", "istanbul": "^1.1.0-alpha.1",
"jsdoc-to-markdown": "^2.0.1", "jsdoc-to-markdown": "^3.0.3",
"mocha": "^3.2.0", "mocha": "^3.5.3",
"mocha-lcov-reporter": "^1.2.0", "mocha-lcov-reporter": "^1.3.0",
"node-static": "^0.7.9" "node-static": "^0.7.10"
}, },
"repository": { "repository": {
"type": "git", "type": "git",