Application Info

Attributes
Methods
class discord.AppInfo(state, data)[ソース]

Represents the application info for the bot provided by Discord.

id

The application ID.

Type:

int

name

The application name.

Type:

str

owner

The application owner.

Type:

User

team

The application's team.

Added in version 1.3.

Type:

Optional[Team]

description

The application 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.

Added 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.

Added 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.

Added 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.

Added in version 1.3.

Type:

Optional[str]

terms_of_service_url

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

Added in version 2.0.

Type:

Optional[str]

privacy_policy_url

The application's privacy policy URL, if set.

Added in version 2.0.

Type:

Optional[str]

approximate_guild_count

The approximate count of guilds to which the app has been added, if any.

Added in version 2.7.

Type:

Optional[int]

approximate_user_install_count

The approximate count of users who have installed the application, if any.

Added in version 2.7.

Type:

Optional[int]

redirect_uris

The list of redirect URIs for the application, if set.

Added in version 2.7.

Type:

Optional[List[str]]

interactions_endpoint_url

The interactions endpoint URL for the application, if set.

Added in version 2.7.

Type:

Optional[str]

role_connections_verification_url

The role connection verification URL for the application, if set.

Added in version 2.7.

Type:

Optional[str]

install_params

The settings for the application's default in-app authorization link, if set.

バージョン 2.8 で変更: Fixed incorrect type documentation.

Type:

Optional[AppInstallParams]

integration_types_config

Per-installation context configuration for guild (0) and user (1) contexts.

Added in version 2.8.

Type:

Optional[IntegrationTypesConfig]

event_webhooks_url

The URL used to receive application event webhooks, if set.

Added in version 2.8.

Type:

Optional[str]

event_webhooks_status

The status of event webhooks for the application, if set.

Added in version 2.8.

Type:

Optional[ApplicationEventWebhookStatus]

event_webhooks_types

List of event webhook types subscribed to, if set.

Added in version 2.8.

Type:

Optional[List[str]]

tags

The list of tags describing the content and functionality of the app, if set.

Maximium of 5 tags.

Added in version 2.7.

Type:

Optional[List[str]]

custom_install_url

The default custom authorization URL for the application, if set.

Added in version 2.7.

Type:

Optional[str]

approximate_user_authorization_count

The approximate count of users who have authorized the application, if any.

Added in version 2.8.

Type:

Optional[int]

bot

The bot user associated with this application, if any.

Added in version 2.8.

Type:

Optional[User]

パラメータ:

  • state (ConnectionState)

  • data (AppInfo)

property flags: ApplicationFlags

The public application flags.

Returns an ApplicationFlags instance.

Added in version 2.8.

await edit(*, description=..., icon=..., cover_image=..., tags=..., terms_of_service_url=..., privacy_policy_url=..., interactions_endpoint_url=..., role_connections_verification_url=..., install_params=..., custom_install_url=..., integration_types_config=..., flags=..., event_webhooks_url=..., event_webhooks_status=..., event_webhooks_types=...)[ソース]

This function is a coroutine.

Edit the current application's settings.

Added in version 2.8.

パラメータ:

  • description (str | None) -- The new application description or None to clear.

  • icon (bytes | None) -- New icon image. If bytes is given it will be base64 encoded automatically. Pass None to clear.

  • cover_image (bytes | None) -- New cover image for the store embed. If bytes is given it will be base64 encoded automatically. Pass None to clear.

  • tags (list[str] | None) -- List of tags for the application (max 5). Pass None to clear.

  • terms_of_service_url (str | None) -- The application's Terms of Service URL. Pass None to clear.

  • privacy_policy_url (str | None) -- The application's Privacy Policy URL. Pass None to clear.

  • interactions_endpoint_url (str | None) -- The interactions endpoint callback URL. Pass None to clear.

  • role_connections_verification_url (str | None) -- The role connection verification URL for the application. Pass None to clear.

  • install_params (AppInstallParams | None) -- Settings for the application's default in-app authorization link. Pass None to clear. Omit entirely to leave unchanged.

  • custom_install_url (str | None) -- The default custom authorization URL for the application. Pass None to clear.

  • integration_types_config (IntegrationTypesConfig | None) -- Object specifying per-installation context configuration (guild and/or user). You may set contexts individually and omit others to leave them unchanged. Pass the object with a context explicitly set to None to clear just that context, or pass None to clear the entire integration types configuration.

  • flags (ApplicationFlags | None) -- Application public flags. Pass None to clear (not typical).

  • event_webhooks_url (str | None) -- Event webhooks callback URL for receiving application webhook events. Pass None to clear.

  • event_webhooks_status (ApplicationEventWebhookStatus) -- The desired webhook status.

  • event_webhooks_types (list[str] | None) -- List of webhook event types to subscribe to. Pass None to clear.

戻り値:

The updated application information.

戻り値の型:

AppInfo

property icon: Asset | None

Retrieves the application's icon asset, if any.

property cover_image: Asset | None

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

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

property guild: Guild | None

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

Added in version 1.3.

property summary: str | None

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

It currently returns an empty string.

Added in version 1.3.

バージョン 2.7 で非推奨.

Attributes
class discord.PartialAppInfo(*, state, data)[ソース]

Represents a partial AppInfo given by create_invite()

Added in version 2.0.

id

The application ID.

Type:

int

name

The application name.

Type:

str

description

The application description.

Type:

str

rpc_origins

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

Type:

Optional[List[str]]

summary

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

Type:

str

verify_key

The hex encoded key for verification in interactions.

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]

パラメータ:

  • state (ConnectionState)

  • data (PartialAppInfo)

property icon: Asset | None

Retrieves the application's icon asset, if any.

Attributes
class discord.AppInstallParams(data)[ソース]

Represents the settings for the custom authorization URL of an application.

Added in version 2.7.

scopes

The list of OAuth2 scopes for adding the application to a guild.

Type:

List[str]

permissions

The permissions to request for the bot role in the guild.

Type:

Permissions

パラメータ:

data (AppInstallParams)

Attributes
class discord.Team(state, data)[ソース]

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.

Added in version 1.3.

Type:

List[TeamMember]

パラメータ:

  • state (ConnectionState)

  • data (Team)

property icon: Asset | None

Retrieves the team's icon asset, if any.

property owner: TeamMember | None

The team's owner.

Attributes
class discord.TeamMember(team, state, data)[ソース]

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 or global_name.

Added 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.

注釈

If the user has migrated to the new username system, this will always be "0".

Type:

str

global_name

The team member's global name.

Added in version 2.5.

Type:

str

avatar

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

role

The role of the team member (e.g. admin, developer, read_only).

Type:

TeamRole

パラメータ:

  • team (Team)

  • state (ConnectionState)

  • data (TeamMember)