Sticker Class

extends Base

Properties

  • client: Client
  • customEmojiId: string
  • emoji: string
  • fileId: string
  • fileSize: number
  • fileUniqueId: string
  • height: number
  • isAnimated: boolean
  • isVideo: boolean
  • maskPosition: MaskPosition
  • needsRepainting: boolean
  • premiumAnimation: File
  • setName: string
  • thumbnail: PhotoSize
  • type: StickerType
  • width: number

Methods

{
  "id": 1836,
  "name": "Sticker",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "children": [
    {
      "id": 1837,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 65,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1838,
          "name": "new Sticker",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/Sticker.ts",
              "line": 65,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1839,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1840,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1836,
            "name": "Sticker",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1856,
      "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": 1853,
      "name": "customEmojiId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "For custom emoji stickers, unique identifier of the custom emoji"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 53,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1849,
      "name": "emoji",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Emoji associated with the sticker"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 41,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1841,
      "name": "fileId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Identifier for this file, which can be used to download or reuse the file"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 11,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1855,
      "name": "fileSize",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "File size in bytes"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 63,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1842,
      "name": "fileUniqueId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier for this file, which is supposed to be the same over time and for different bots.\nCan't be used to download or reuse the file."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 17,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1845,
      "name": "height",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker height"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 29,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1846,
      "name": "isAnimated",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the sticker is animated"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 32,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1847,
      "name": "isVideo",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the sticker is a video"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 35,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1852,
      "name": "maskPosition",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "For mask stickers, the position where the mask should be placed"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 50,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2113,
        "name": "MaskPosition",
        "package": "tgkit"
      }
    },
    {
      "id": 1854,
      "name": "needsRepainting",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "If the sticker must be repainted to a text color in messages,\nthe color of the Telegram Premium badge in emoji status\nwhite color on chat photos, or another appropriate color in other places"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 60,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1851,
      "name": "premiumAnimation",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "For premium regular stickers, premium animation for the sticker"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 47,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1285,
        "name": "File",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1850,
      "name": "setName",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Name of the sticker set to which the sticker belongs"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 44,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1848,
      "name": "thumbnail",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker thumbnail in the .WEBP or .JPG format"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 38,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1726,
        "name": "PhotoSize",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1843,
      "name": "type",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Type of the sticker. The type of the sticker is independent from its format,\nwhich is determined by the fields "
          },
          {
            "kind": "code",
            "text": "`isAnimated`"
          },
          {
            "kind": "text",
            "text": " and "
          },
          {
            "kind": "code",
            "text": "`isVideo`"
          },
          {
            "kind": "text",
            "text": "."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 23,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2066,
        "name": "StickerType",
        "package": "tgkit"
      }
    },
    {
      "id": 1844,
      "name": "width",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sticker width"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Sticker.ts",
          "line": 26,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1837
      ]
    },
    {
      "title": "Properties",
      "children": [
        1856,
        1853,
        1849,
        1841,
        1855,
        1842,
        1845,
        1846,
        1847,
        1852,
        1854,
        1851,
        1850,
        1848,
        1843,
        1844
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/Sticker.ts",
      "line": 9,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}