StickerSet Class

extends Base

Represents a sticker set.

Properties

  • client: Client
  • isAnimated: boolean
  • isVideo: boolean
  • name: string
  • stickers:
  • thumbnail: PhotoSize
  • title: string
  • type: StickerType

Methods

{
  "id": 1857,
  "name": "StickerSet",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Represents a sticker set."
      }
    ]
  },
  "children": [
    {
      "id": 1858,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 31,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1859,
          "name": "new StickerSet",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/StickerSet.ts",
              "line": 31,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1860,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1861,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1857,
            "name": "StickerSet",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1869,
      "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": 1865,
      "name": "isAnimated",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the sticker set contains animated stickers"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 20,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1866,
      "name": "isVideo",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the sticker set contains video stickers"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 23,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1862,
      "name": "name",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker set name"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 11,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1867,
      "name": "stickers",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "List of all set stickers"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 26,
          "character": 1
        }
      ],
      "type": {
        "type": "array",
        "elementType": {
          "type": "reference",
          "target": 1836,
          "name": "Sticker",
          "package": "tgkit",
          "qualifiedName": "default"
        }
      }
    },
    {
      "id": 1868,
      "name": "thumbnail",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 29,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1726,
        "name": "PhotoSize",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1863,
      "name": "title",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker set title"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 14,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1864,
      "name": "type",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Type of stickers in the set"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StickerSet.ts",
          "line": 17,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2066,
        "name": "StickerType",
        "package": "tgkit"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1858
      ]
    },
    {
      "title": "Properties",
      "children": [
        1869,
        1865,
        1866,
        1862,
        1867,
        1868,
        1863,
        1864
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/StickerSet.ts",
      "line": 9,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}