Class Forum

Hierarchy (View Summary)

Constructors

constructor

Properties

chatId threadId

Accessors

client

Methods

_clone _patch _update close delete edit reopen toJSON unpinAllMessages valueOf

Constructors

constructor

Properties

chatId

chatId: string

Unique identifier for this chat

threadId

threadId: string

Unique identifier of the forum topic

Accessors

client

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data: Record<string, any>): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data: Record<string, any>): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

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?: { customEmojiId?: string; name?: string }): 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?: boolean,
        ...props: Record<string, string | boolean>[],
    ): 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.

    • ...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 chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively.

    Returns Promise<true>

    Returns True on success.

valueOf

  • valueOf(): null | string

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

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods