hikari.stickers#

Application and entities that are used to describe stickers on Discord.

Module Contents#

class hikari.stickers.StickerType[source]#

Bases: int, hikari.internal.enums.Enum

The sticker type.

STANDARD = 1[source]#: An official sticker in a pack, part of Nitro or in a removed purchasable pack.

GUILD = 2[source]#: A sticker uploaded to a guild.

class hikari.stickers.StickerFormatType[source]#

Bases: int, hikari.internal.enums.Enum

The formats types of a sticker’s asset.

PNG = 1[source]#: A PNG sticker.

APNG = 2[source]#: A animated PNG sticker.

LOTTIE = 3[source]#

A lottie sticker.

More information can be found here: <https://airbnb.io/lottie/>

class hikari.stickers.StickerPack[source]#

Bases: hikari.snowflakes.Unique

Represents a sticker pack on Discord.

property banner_url: hikari.files.URL[source]#: Banner URL for the pack.

id: hikari.snowflakes.Snowflake[source]#: The ID of this entity.

name: str[source]#: The name of the pack.

description: str[source]#: The description of the pack.

cover_sticker_id: Optional[hikari.snowflakes.Snowflake][source]#: The ID of a sticker in the pack which is shown as the pack’s icon.

stickers: Sequence[StandardSticker][source]#: The stickers that belong to this pack.

sku_id: hikari.snowflakes.Snowflake[source]#: The ID of the packs SKU.

banner_hash: str[source]#: The hash for the pack’s banner.

make_banner_url(*, ext='png', size=4096)[source]#

Generate the pack’s banner image URL.

Parameters

extstr: The extension to use for this URL, defaults to png. Supports png, jpeg, jpg and webp.
sizeint: The size to set for the URL, defaults to 4096. Can be any power of two between 16 and 4096.

Returns

hikari.files.URL: The URL of the banner.

Raises

ValueError: If size is not a power of two or not between 16 and 4096.

class hikari.stickers.PartialSticker[source]#

Bases: hikari.snowflakes.Unique

Represents the partial stickers found attached to messages on Discord.

property image_url: hikari.files.URL[source]#

URL for the image.

The extension will be based on format_type. If format_type is StickerFormatType.LOTTIE, then the extension will be json. Otherwise, it will be png.

id: hikari.snowflakes.Snowflake[source]#: The ID of this entity.

name: str[source]#: The name of the sticker.

format_type: Union[StickerFormatType, int][source]#: The format of this sticker’s asset.

class hikari.stickers.StandardSticker[source]#

Bases: PartialSticker

Represents a standard Discord sticker that belongs to a pack.

type: StickerType[source]#: The sticker type.

description: Optional[str][source]#: The description of this sticker.

pack_id: hikari.snowflakes.Snowflake[source]#: ID of the package this sticker belongs to.

sort_value: int[source]#: The sort value for the sticker in its pack.

tags: Sequence[str][source]#: A sequence of this sticker’s tags.

class hikari.stickers.GuildSticker[source]#

Bases: PartialSticker

Represents a Discord sticker that belongs to a guild.

type: StickerType[source]#: The sticker type.

description: Optional[str][source]#: The description of this sticker.

guild_id: hikari.snowflakes.Snowflake[source]#: The guild this sticker belongs to.

is_available: bool[source]#: Whether the sticker can be used.

tag: str[source]#: This sticker’s tag.

user: Optional[hikari.users.User][source]#

The user that uploaded this sticker.

This will only available if you have the MANAGE_EMOJIS_AND_STICKERS permission.