mirror of
https://github.com/yagop/node-telegram-bot-api
synced 2025-09-01 14:55:14 +00:00
doc: Minor fixes, Update changelog
This commit is contained in:
@@ -7,6 +7,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
|
|
||||||
Added:
|
Added:
|
||||||
|
|
||||||
|
1. Add Bot API v3.4 methods:
|
||||||
|
* (#439) *TelegramBot#editMessageLiveLocation*, *TelegramBot#stopMessageLiveLocation* (by @kamikazechaser)
|
||||||
1. Add `metadata` argument in `message` event (and
|
1. Add `metadata` argument in `message` event (and
|
||||||
friends e.g. `text`, `audio`, etc.) (#409) (by @jlsjonas, @GochoMugo)
|
friends e.g. `text`, `audio`, etc.) (#409) (by @jlsjonas, @GochoMugo)
|
||||||
1. Add support for Node.js v9 (by @GochoMugo)
|
1. Add support for Node.js v9 (by @GochoMugo)
|
||||||
|
20
doc/api.md
20
doc/api.md
@@ -707,32 +707,36 @@ Use this method to send point on the map.
|
|||||||
<a name="TelegramBot+editMessageLiveLocation"></a>
|
<a name="TelegramBot+editMessageLiveLocation"></a>
|
||||||
|
|
||||||
### telegramBot.editMessageLiveLocation(latitude, longitude, [options]) ⇒ <code>Promise</code>
|
### telegramBot.editMessageLiveLocation(latitude, longitude, [options]) ⇒ <code>Promise</code>
|
||||||
Edit live location.
|
Use this method to edit live location messages sent by
|
||||||
Use this method to edit live location messages.
|
the bot or via the bot (for inline bots).
|
||||||
|
|
||||||
|
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>
|
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||||
**Info**: You must pass in either a chat_id, message_id or an inline_message_id in your addidtional options.
|
|
||||||
**See**: https://core.telegram.org/bots/api#editmessagelivelocation
|
**See**: https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| 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 (provide either one of chat_id, message_id, or inline_message_id here) |
|
||||||
|
|
||||||
<a name="TelegramBot+stopMessageLiveLocation"></a>
|
<a name="TelegramBot+stopMessageLiveLocation"></a>
|
||||||
|
|
||||||
### telegramBot.stopMessageLiveLocation([options]) ⇒ <code>Promise</code>
|
### telegramBot.stopMessageLiveLocation([options]) ⇒ <code>Promise</code>
|
||||||
Stop live location.
|
Use this method to stop updating a live location message sent by
|
||||||
Use this method to stop updating live location messages.
|
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
|
||||||
|
inline_message_id in your request.
|
||||||
|
|
||||||
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
**Kind**: instance method of <code>[TelegramBot](#TelegramBot)</code>
|
||||||
**Info**: You must pass in either a chat_id, message_id or an inline_message_id in your addidtional options.
|
|
||||||
**See**: https://core.telegram.org/bots/api#stopmessagelivelocation
|
**See**: https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [options] | <code>Object</code> | Additional Telegram query options |
|
| [options] | <code>Object</code> | Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here) |
|
||||||
|
|
||||||
<a name="TelegramBot+sendVenue"></a>
|
<a name="TelegramBot+sendVenue"></a>
|
||||||
|
|
||||||
|
@@ -1186,14 +1186,16 @@ class TelegramBot extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Edit live location.
|
* Use this method to edit live location messages sent by
|
||||||
* Use this method to edit live location messages.
|
* the bot or via the bot (for inline bots).
|
||||||
|
*
|
||||||
|
* Note that you must provide one of chat_id, message_id, or
|
||||||
|
* inline_message_id in your request.
|
||||||
*
|
*
|
||||||
* @param {Float} latitude Latitude of location
|
* @param {Float} latitude Latitude of location
|
||||||
* @param {Float} longitude Longitude of location
|
* @param {Float} longitude Longitude of location
|
||||||
* @param {Object} [options] Additional Telegram query options
|
* @param {Object} [options] Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here)
|
||||||
* @return {Promise}
|
* @return {Promise}
|
||||||
* @info You must pass in either a chat_id, message_id or an inline_message_id in your addidtional options.
|
|
||||||
* @see https://core.telegram.org/bots/api#editmessagelivelocation
|
* @see https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
*/
|
*/
|
||||||
editMessageLiveLocation(latitude, longitude, form = {}) {
|
editMessageLiveLocation(latitude, longitude, form = {}) {
|
||||||
@@ -1201,19 +1203,21 @@ class TelegramBot extends EventEmitter {
|
|||||||
form.longitude = longitude;
|
form.longitude = longitude;
|
||||||
return this._request('editMessageLiveLocation', { form });
|
return this._request('editMessageLiveLocation', { form });
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stop live location.
|
* Use this method to stop updating a live location message sent by
|
||||||
* Use this method to stop updating live location messages.
|
* the bot or via the bot (for inline bots) before live_period expires.
|
||||||
*
|
*
|
||||||
* @param {Object} [options] Additional Telegram query options
|
* Note that you must provide one of chat_id, message_id, or
|
||||||
|
* inline_message_id in your request.
|
||||||
|
*
|
||||||
|
* @param {Object} [options] Additional Telegram query options (provide either one of chat_id, message_id, or inline_message_id here)
|
||||||
* @return {Promise}
|
* @return {Promise}
|
||||||
* @info You must pass in either a chat_id, message_id or an inline_message_id in your addidtional options.
|
|
||||||
* @see https://core.telegram.org/bots/api#stopmessagelivelocation
|
* @see https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
*/
|
*/
|
||||||
stopMessageLiveLocation(form = {}) {
|
stopMessageLiveLocation(form = {}) {
|
||||||
return this._request('stopMessageLiveLocation', { form });
|
return this._request('stopMessageLiveLocation', { form });
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send venue.
|
* Send venue.
|
||||||
|
Reference in New Issue
Block a user