Application Info¶

This section documents everything related to application information.

Discord Models¶

AppInfo¶

class disnake.AppInfo[source]¶

This class is a Discord Model.

Represents the application info for the bot provided by Discord.

id¶

The application’s ID.

Type:: int

name¶

The application’s name.

Type:: str

owner¶

The application’s owner.

Type:: User

team¶

The application’s team.

New in version 1.3.

Type:: Optional[Team]

description¶

The application’s description.

Type:: str

bot_public¶

Whether the bot can be invited by anyone or if it is locked to the application owner.

Type:: bool

bot_require_code_grant¶

Whether the bot requires the completion of the full oauth2 code grant flow to join.

Type:: bool

rpc_origins¶

A list of RPC origin URLs, if RPC is enabled.

Type:: Optional[List[str]]

verify_key¶

The hex encoded key for verification in interactions and the GameSDK’s GetTicket.

New in version 1.3.

Type:: str

guild_id¶

If this application is a game sold on Discord, this field will be the guild to which it has been linked to.

New in version 1.3.

Type:: Optional[int]

primary_sku_id¶

If this application is a game sold on Discord, this field will be the ID of the “Game SKU” that is created, if it exists.

New in version 1.3.

Type:: Optional[int]

slug¶

If this application is a game sold on Discord, this field will be the URL slug that links to the store page.

New in version 1.3.

Type:: Optional[str]

terms_of_service_url¶

The application’s terms of service URL, if set.

New in version 2.0.

Type:: Optional[str]

privacy_policy_url¶

The application’s privacy policy URL, if set.

New in version 2.0.

Type:: Optional[str]

flags¶

The application’s public flags.

New in version 2.3.

Type:: Optional[ApplicationFlags]

tags¶

The application’s tags.

New in version 2.5.

Type:: Optional[List[str]]

install_params¶

The installation parameters for this application.

New in version 2.5.

Type:: Optional[InstallParams]

custom_install_url¶

The custom installation url for this application.

New in version 2.5.

Type:: Optional[str]

property icon[source]¶

Retrieves the application’s icon asset, if any.

Type:: Optional[Asset]

property cover_image[source]¶

Retrieves the cover image on a store embed, if any.

This is only available if the application is a game sold on Discord.

Type:: Optional[Asset]

property guild[source]¶

If this application is a game sold on Discord, this field will be the guild to which it has been linked

New in version 1.3.

Type:: Optional[Guild]

property summary[source]¶

If this application is a game sold on Discord, this field will be the summary field for the store page of its primary SKU.

New in version 1.3.

Deprecated since version 2.5: This field is deprecated by discord and is now always blank. Consider using description instead.

Type:: str

PartialAppInfo¶

Attributes

description
icon
id
name
privacy_policy_url
rpc_origins
summary
terms_of_service_url
verify_key

class disnake.PartialAppInfo[source]¶

This class is a Discord Model.

Represents a partial AppInfo given by create_invite().

New in version 2.0.

id¶

The application’s ID.

Type:: int

name¶

The application’s name.

Type:: str

description¶

The application’s description.

Type:: str

rpc_origins¶

A list of RPC origin URLs, if RPC is enabled.

Type:: Optional[List[str]]

verify_key¶

The hex encoded key for verification in interactions and the GameSDK’s GetTicket.

Type:: str

terms_of_service_url¶

The application’s terms of service URL, if set.

Type:: Optional[str]

privacy_policy_url¶

The application’s privacy policy URL, if set.

Type:: Optional[str]

property icon[source]¶

Retrieves the application’s icon asset, if any.

Type:: Optional[Asset]

property summary[source]¶

If this application is a game sold on Discord, this field will be the summary field for the store page of its primary SKU.

Deprecated since version 2.5: This field is deprecated by discord and is now always blank. Consider using description instead.

Type:: str

Team¶

Attributes

icon
id
members
name
owner
owner_id

class disnake.Team[source]¶

This class is a Discord Model.

Represents an application team for a bot provided by Discord.

id¶

The team ID.

Type:: int

name¶

The team name.

Type:: str

owner_id¶

The team’s owner ID.

Type:: int

members¶

A list of the members in the team.

New in version 1.3.

Type:: List[TeamMember]

property icon[source]¶

Retrieves the team’s icon asset, if any.

Type:: Optional[Asset]

property owner[source]¶

The team’s owner.

Type:: Optional[TeamMember]

TeamMember¶

Attributes

avatar
bot
discriminator
id
membership_state
name
team

class disnake.TeamMember[source]¶

This class is a Discord Model.

Represents a team member in a team.

x == y: Checks if two team members are equal.

x != y: Checks if two team members are not equal.

hash(x): Return the team member’s hash.

str(x): Returns the team member’s name with discriminator.

New in version 1.3.

name¶

The team member’s username.

Type:: str

id¶

The team member’s unique ID.

Type:: int

discriminator¶

The team member’s discriminator. This is given when the username has conflicts.

Type:: str

avatar[source]¶

The avatar hash the team member has. Could be None.

Type:: Optional[str]

bot¶

Specifies if the user is a bot account.

Type:: bool

team¶

The team that the member is from.

Type:: Team

membership_state¶

The membership state of the member (e.g. invited or accepted)

Type:: TeamMembershipState

Data Classes¶

ApplicationFlags¶

Attributes

application_command_badge
embedded
gateway_guild_members
gateway_guild_members_limited
gateway_message_content
gateway_message_content_limited
gateway_presence
gateway_presence_limited
value
verification_pending_guild_limit

class disnake.ApplicationFlags(**kwargs)[source]¶

This class is a Data Class.

Wraps up the Discord Application flags.

x == y: Checks if two ApplicationFlags instances are equal.

x != y: Checks if two ApplicationFlags instances are not equal.

x <= y: Checks if an ApplicationFlags instance is a subset of another ApplicationFlags instance.

New in version 2.6.

x >= y: Checks if an ApplicationFlags instance is a superset of another ApplicationFlags instance.

New in version 2.6.

x < y: Checks if an ApplicationFlags instance is a strict subset of another ApplicationFlags instance.

New in version 2.6.

x > y: Checks if an ApplicationFlags instance is a strict superset of another ApplicationFlags instance.

New in version 2.6.

x | y, x |= y: Returns a new ApplicationFlags instance with all enabled flags from both x and y. (Using |= will update in place).

New in version 2.6.

x & y, x &= y: Returns a new ApplicationFlags instance with only flags enabled on both x and y. (Using &= will update in place).

New in version 2.6.

x ^ y, x ^= y: Returns a new ApplicationFlags instance with only flags enabled on one of x or y, but not both. (Using ^= will update in place).

New in version 2.6.

~x: Returns a new ApplicationFlags instance with all flags from x inverted.

New in version 2.6.

hash(x): Return the flag’s hash.

iter(x): Returns an iterator of (name, value) pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown.

Additionally supported are a few operations on class attributes.

ApplicationFlags.y | ApplicationFlags.z, ApplicationFlags(y=True) | ApplicationFlags.z: Returns a ApplicationFlags instance with all provided flags enabled.

New in version 2.6.

~ApplicationFlags.y: Returns a ApplicationFlags instance with all flags except y inverted from their default value.

New in version 2.6.

New in version 2.0.

value¶

The raw value. You should query flags via the properties rather than using this raw value.

Type:: int

gateway_presence¶

Returns True if the application is verified and is allowed to receive presence information over the gateway.

Type:: bool

gateway_presence_limited¶

Returns True if the application is allowed to receive limited presence information over the gateway.

Type:: bool

gateway_guild_members¶

Returns True if the application is verified and is allowed to receive guild members information over the gateway.

Type:: bool

gateway_guild_members_limited¶

Returns True if the application is allowed to receive limited guild members information over the gateway.

Type:: bool

verification_pending_guild_limit¶

Returns True if the application is currently pending verification and has hit the guild limit.

Type:: bool

embedded¶

Returns True if the application is embedded within the Discord client.

Type:: bool

gateway_message_content¶

Returns True if the application is verified and is allowed to receive message content over the gateway.

Type:: bool

gateway_message_content_limited¶

Returns True if the application is verified and is allowed to receive limited message content over the gateway.

Type:: bool

application_command_badge¶

Returns True if the application has registered global application commands.

New in version 2.6.

Type:: bool

InstallParams¶

Attributes

permissions
scopes

Methods

defto_url

class disnake.InstallParams[source]¶

This class is a Data Class.

Represents the installation parameters for the application, provided by Discord.

New in version 2.5.

scopes¶

The scopes requested by the application.

Type:: List[str]

permissions¶

The permissions requested for the bot role.

Type:: Permissions

to_url()[source]¶

Return a string that can be used to add this application to a server.

Returns:: The invite url.
Return type:: str

Enumerations¶

TeamMembershipState¶

class disnake.TeamMembershipState[source]¶

This class is an Enumeration.

Represents the membership state of a team member retrieved through Client.application_info().

New in version 1.3.

invited¶: Represents an invited member.

accepted¶: Represents a member currently in the team.