diff --git a/CHANGELOG.md b/CHANGELOG.md index ecfe391a..ae7ebb84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,9 +3,13 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [0.63.0][0.61.0] - 2023-08-23 +1. Support Telegram Bot API v6.8 (@danielperez9430) + * unpinAllGeneralForumTopicMessages + ## [0.62.0][0.62.0] - 2023-03-19 -1. Support Telegram Bot API v6.6 (@danielperez9430) +1. Support Telegram Bot API v6.6 & v6.7 (@danielperez9430) * setMyDescription * getMyDescription * setMyShortDescription diff --git a/README.md b/README.md index 7d9dbcb6..649c77d2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Node.js module to interact with the official [Telegram Bot API](https://core.telegram.org/bots/api). -[![Bot API](https://img.shields.io/badge/Bot%20API-v.6.3-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api) +[![Bot API](https://img.shields.io/badge/Bot%20API-v.6.8-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api) [![npm package](https://img.shields.io/npm/v/node-telegram-bot-api?logo=npm&style=flat-square)](https://www.npmjs.org/package/node-telegram-bot-api) [![Build Status](https://img.shields.io/travis/yagop/node-telegram-bot-api/master?style=flat-square&logo=travis)](https://travis-ci.org/yagop/node-telegram-bot-api) [![Coverage Status](https://img.shields.io/codecov/c/github/yagop/node-telegram-bot-api?style=flat-square&logo=codecov)](https://codecov.io/gh/yagop/node-telegram-bot-api) diff --git a/doc/api.md b/doc/api.md index c4785ff9..81812fdb 100644 --- a/doc/api.md +++ b/doc/api.md @@ -99,6 +99,7 @@ TelegramBot * [.reopenGeneralForumTopic(chatId, [options])](#TelegramBot+reopenGeneralForumTopic) ⇒ Promise * [.hideGeneralForumTopic(chatId, [options])](#TelegramBot+hideGeneralForumTopic) ⇒ Promise * [.unhideGeneralForumTopic(chatId, [options])](#TelegramBot+unhideGeneralForumTopic) ⇒ Promise + * [.unpinAllGeneralForumTopicMessages(chatId, [options])](#TelegramBot+unpinAllGeneralForumTopicMessages) ⇒ Promise * [.answerCallbackQuery(callbackQueryId, [options])](#TelegramBot+answerCallbackQuery) ⇒ Promise * [.setMyCommands(commands, [options])](#TelegramBot+setMyCommands) ⇒ Promise * [.deleteMyCommands([options])](#TelegramBot+deleteMyCommands) ⇒ Promise @@ -440,7 +441,7 @@ that is being deprecated. | url | String | URL where Telegram will make HTTP Post. Leave empty to delete webHook. | | [options] | Object | Additional Telegram query options | | [options.certificate] | String \| stream.Stream | PEM certificate key (public). | -| [options.secret_token] | String | A secret token to be sent in a header `X-Telegram-Bot-Api-Secret-Token` in every webhook request. | +| [options.secret_token] | String | Optional secret token to be sent in a header `X-Telegram-Bot-Api-Secret-Token` in every webhook request. | | [fileOptions] | Object | Optional file related meta-data | @@ -1581,6 +1582,21 @@ The bot must be an administrator in the chat for this to work and must have the | chatId | Number \| String | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) | | [options] | Object | Additional Telegram query options | + + +### telegramBot.unpinAllGeneralForumTopicMessages(chatId, [options]) ⇒ Promise +Use this method to clear the list of pinned messages in a General forum topic. +The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. + +**Kind**: instance method of [TelegramBot](#TelegramBot) +**Returns**: Promise - True on success +**See**: https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages + +| Param | Type | Description | +| --- | --- | --- | +| chatId | Number \| String | Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) | +| [options] | Object | Additional Telegram query options | + ### telegramBot.answerCallbackQuery(callbackQueryId, [options]) ⇒ Promise diff --git a/package.json b/package.json index d26fecbf..e132fd91 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-telegram-bot-api", - "version": "0.61.0", + "version": "0.63.0", "description": "Telegram Bot API", "main": "./index.js", "directories": { diff --git a/src/telegram.js b/src/telegram.js index b6596077..9e26f44c 100644 --- a/src/telegram.js +++ b/src/telegram.js @@ -2069,6 +2069,20 @@ class TelegramBot extends EventEmitter { return this._request('unhideGeneralForumTopic', { form }); } + /** + * Use this method to clear the list of pinned messages in a General forum topic. + * The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. + * + * @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername) + * @param {Object} [options] Additional Telegram query options + * @return {Promise} True on success + * @see https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages + */ + unpinAllGeneralForumTopicMessages(chatId, form = {}) { + form.chat_id = chatId; + return this._request('unhideGeneralForumTopic', { form }); + } + /** * Use this method to send answers to callback queries sent from * [inline keyboards](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). diff --git a/src/telegramWebHook.js b/src/telegramWebHook.js index 7ce4de15..a8a8f8ba 100644 --- a/src/telegramWebHook.js +++ b/src/telegramWebHook.js @@ -45,7 +45,7 @@ class TelegramBotWebHook { /** * Open WebHook by listening on the port * @return {Promise} - */ + */ open() { if (this.isOpen()) { return Promise.resolve();