hikari.stickers#
Application and entities that are used to describe stickers on Discord.
Module Contents#
- class hikari.stickers.GuildSticker[source]#
Bases:
PartialSticker
Represents a Discord sticker that belongs to a guild.
- guild_id: hikari.snowflakes.Snowflake[source]#
The guild this sticker belongs to.
- type: StickerType[source]#
The sticker type.
- user: hikari.users.User | None[source]#
The user that uploaded this sticker.
This will only available if you have the
MANAGE_EMOJIS_AND_STICKERS
permission.
- 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
. Ifformat_type
isStickerFormatType.LOTTIE
, then the extension will bejson
, if it’sStickerFormatType.GIF
it will begif
. Otherwise, it will bepng
.
- format_type: StickerFormatType | int[source]#
The format of this sticker’s asset.
- id: hikari.snowflakes.Snowflake[source]#
The ID of this entity.
- class hikari.stickers.StandardSticker[source]#
Bases:
PartialSticker
Represents a standard Discord sticker that belongs to a pack.
- pack_id: hikari.snowflakes.Snowflake[source]#
ID of the package this sticker belongs to.
- type: StickerType[source]#
The sticker type.
- class hikari.stickers.StickerFormatType[source]#
Bases:
int
,hikari.internal.enums.Enum
The formats types of a sticker’s asset.
- 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 | None[source]#
Banner URL for the pack, if set.
- banner_asset_id: hikari.snowflakes.Snowflake | None[source]#
ID of the sticker pack’s banner image, if set.
- cover_sticker_id: hikari.snowflakes.Snowflake | None[source]#
The ID of a sticker in the pack which is shown as the pack’s icon.
- id: hikari.snowflakes.Snowflake[source]#
The ID of this entity.
- sku_id: hikari.snowflakes.Snowflake[source]#
The ID of the packs SKU.
- stickers: Sequence[StandardSticker][source]#
The stickers that belong to this pack.
- make_banner_url(*, ext='png', size=4096)[source]#
Generate the pack’s banner image URL, if set.
- Parameters:
- Returns:
typing.Optional
[hikari.files.URL
]The URL of the banner, if set.
- Raises:
ValueError
If
size
is not a power of two or not between 16 and 4096.