ForumTopic Class

extends Base

Represents a forum topic.

Properties

  • client: Client
  • iconColor: number
  • iconCustomEmojiId: string
  • id: number
  • name: string

Methods

{
  "id": 1295,
  "name": "ForumTopic",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Represents a forum topic."
      }
    ]
  },
  "children": [
    {
      "id": 1296,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
          "line": 18,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1297,
          "name": "new ForumTopic",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
              "line": 18,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1298,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1299,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1295,
            "name": "ForumTopic",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1304,
      "name": "client",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isInherited": true
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Base.ts",
          "line": 4,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1,
        "name": "Client",
        "package": "tgkit",
        "qualifiedName": "default"
      },
      "inheritedFrom": {
        "type": "reference",
        "target": -1,
        "name": "Base.client"
      }
    },
    {
      "id": 1302,
      "name": "iconColor",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Color of the topic icon in RGB format"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
          "line": 13,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1303,
      "name": "iconCustomEmojiId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier of the custom emoji shown as the topic icon"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
          "line": 16,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1300,
      "name": "id",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier of the forum topic"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
          "line": 7,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1301,
      "name": "name",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Name of the topic"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
          "line": 10,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1296
      ]
    },
    {
      "title": "Properties",
      "children": [
        1304,
        1302,
        1303,
        1300,
        1301
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/ForumTopic.ts",
      "line": 5,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}