Class ForumTopic

chatId

threadId

client

• get client(): TelegramClient

• The client that instantiated this

  Returns TelegramClient

close

• close(): Promise<true>

• Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic.

  Returns Promise<true>

  Returns True on success.

delete

• delete(): Promise<true>

• Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights.

  Returns Promise<true>

  Returns True on success.

edit

• edit(options?): Promise<true>

• Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic.

  Parameters

  • Optionaloptions: {
        customEmojiId?: string;
        name?: string;
    }

    Options for edited forum topic.

    • OptionalcustomEmojiId?: string

      New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept

    • Optionalname?: string

      New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept

  Returns Promise<true>

  Returns True on success.

reopen

• reopen(): Promise<true>

• Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic.

  Returns Promise<true>

  Returns True on success.

toJSON

• toJSON(propsRecursive?, ...props): Record<string, any>

• Flatten an object. Any properties that are collections will get converted to an array of keys.

  Parameters

  • OptionalpropsRecursive: boolean

    Optional. If true, calls toJSON method on nested objects.
  • Rest...props: Record<string, string | boolean>[]

    Optional. Specific properties to include/exclude, or rename.

  Returns Record<string, any>

  Flattened object.

unpinAllMessages

• unpinAllMessages(): Promise<true>

• Use this method to clear the list of pinned messages in a 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.

  Returns Promise<true>

  Returns True on success.

valueOf

• valueOf(): null | string

• Returns the id instance Chat, User, ChatMember and other

  Returns null | string