unpinAllForumTopicMessages()
Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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. Returns True on success.
parameters
| parameter | type | required | description |
|---|---|---|---|
chat_id | number | string | required | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | number | required | Unique identifier for the target message thread of the forum topic |
returns
boolean
usage in yaebal
not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.
import type { UnpinAllForumTopicMessagesParams } from "@yaebal/types";
await bot.api.call<boolean>("unpinAllForumTopicMessages", {
chat_id: 123456789,
message_thread_id: 1,
} satisfies UnpinAllForumTopicMessagesParams);context shortcut
also available as ctx.unpinAllForumTopicMessages() on
16
context types — see @yaebal/contexts.
/** Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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. Returns *True* on success. */
ctx.unpinAllForumTopicMessages(params: Omit<UnpinAllForumTopicMessagesParams, "chat_id">)official Bot API docs: https://core.telegram.org/bots/api/#unpinallforumtopicmessages