Class StickerSet

constructor

• new StickerSet(raw): StickerSet

• Parameters

  • raw: RawStickerSet | TypeStickerSetCovered | TypeStickerSet

  Returns StickerSet

Readonlybrief

Optional Readonlycover

Optional Readonlyfull

ReadonlyisFull

count

• get count(): number

• Number of stickers in this sticker set

  Returns number

covers

• get covers(): readonly Sticker[]

• Cover stickers of the sticker set. Not the same as thumbnails

  Returns readonly Sticker[]

inputStickerSet

• get inputStickerSet(): TypeInputStickerSet

• Input sticker set to be used in other API methods

  Returns TypeInputStickerSet

installedDate

• get installedDate(): null | Date

• Date when this sticker set was installed

  Returns null | Date

isArchived

• get isArchived(): boolean

• Whether this sticker set was archived (due to too many saved stickers in the current account)

  Returns boolean

isCreator

• get isCreator(): boolean

• Whether this sticker set was created by the current user

  Returns boolean

isOfficial

• get isOfficial(): boolean

• Whether this stickerset is official

  Returns boolean

shortName

• get shortName(): string

• Short name of sticker set to use in tg://addstickers?set=short_name or https://t.me/addstickers/short_name

  Returns string

sourceType

• get sourceType(): StickerSourceType

• Source file type of the stickers in this set

  Returns StickerSourceType

stickers

• get stickers(): readonly StickerInfo[]

• List of stickers inside this sticker set

  Returns readonly StickerInfo[]

  Throws

  MtEmptyError In case this object does not contain info about stickers (i.e. isFull = false)

thumbnails

• get thumbnails(): readonly Thumbnail[]

• Available sticker set thumbnails.

  Returns empty array if not available (i.e. first sticker should be used as thumbnail)

  Returns readonly Thumbnail[]

title

• get title(): string

• Title of the sticker set

  Returns string

type

• get type(): StickerType

• Type of the stickers in this set

  Returns StickerType

getStickersByEmoji

• getStickersByEmoji(emoji): StickerInfo[]

• Find stickers given their emoji.

  Parameters

  • emoji: string

    Emoji to search for

  Returns StickerInfo[]

  Throws

  MtEmptyError In case this object does not contain info about stickers (i.e. isFull = false)

getThumbnail

• getThumbnail(type): null | Thumbnail

• Get a sticker set thumbnail by its type.

  Thumbnail types are described in the Telegram docs, and are also available as static members of Thumbnail for convenience.

  Parameters

  • type: string

    Thumbnail type

  Returns null | Thumbnail