Skip to content

Objects

emoji

EmojiModel dataclass

Bases: DataModel


              flowchart TD
              scurrypy.api.emoji.EmojiModel[EmojiModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.emoji.EmojiModel
                


              click scurrypy.api.emoji.EmojiModel href "" "scurrypy.api.emoji.EmojiModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Represents a Discord emoji.

name: str instance-attribute

Name of emoji.

id: Snowflake | None = None class-attribute instance-attribute

ID of the emoji (if custom).

animated: bool = False class-attribute instance-attribute

If the emoji is animated. Defaults to False.

is_custom: bool property

mention: str property

Mention this emoji in a message.

api_code: str property

API code for this emoji (URL-safe).

url: str | None property

Full qualifying link for this emoji.

Important

This only works for custom Discord emojis (those with an ID). Unicode emojis will return None.

ApplicationEmojiPart dataclass

Bases: DataModel


              flowchart TD
              scurrypy.api.emoji.ApplicationEmojiPart[ApplicationEmojiPart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.emoji.ApplicationEmojiPart
                


              click scurrypy.api.emoji.ApplicationEmojiPart href "" "scurrypy.api.emoji.ApplicationEmojiPart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Represents fields for creating a bot emoji.

name: str | None = None class-attribute instance-attribute

Name of the emoji.

image: ImageDataPart | None = None class-attribute instance-attribute

Image data for the icon of the emoji.

GuildEmojiPart dataclass

Bases: DataModel


              flowchart TD
              scurrypy.api.emoji.GuildEmojiPart[GuildEmojiPart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.emoji.GuildEmojiPart
                


              click scurrypy.api.emoji.GuildEmojiPart href "" "scurrypy.api.emoji.GuildEmojiPart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Represents fields for creating a guild emoji.

name: str | None = None class-attribute instance-attribute

Name of the emoji.

image: ImageDataPart | None = None class-attribute instance-attribute

Image data for the icon of the emoji.

roles: list[Snowflake] | None = None class-attribute instance-attribute

Roles able to use the emoji.