Core

The core mechanisms for using all of the library’s components collaboratively.

client

class aiocord.client.HTTPMeddle(...)

Bases: Generic[_V]

Returned for all HTTP-related methods.

Facilitates editing a request’s options before it’s performed.

Useful for attaching request/request-specific headers.

awaiting the instance will perform the request.

request = client.update_channel(channel_id, topic = 'silly fun')
request.set_reason('just so things dont get too serious')
channel = await request

set_reason(value)

Set the Audit Log Reason for executing this request.

class aiocord.client.GatewayCache(...)

Bases: Object

Holds objects during gateway connections.

user: Source:

guilds: Source:

application: Source:

class aiocord.client.Client(token=None, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of interaction with the Discord API components.

Parameters:

• token – The type-less authentication token.

• loads – Used for converting json text to objects.

• dumps – Used for converting json objects to text.

property session: ClientSession

The session for making requests.

property http: Client

The HTTP client for executing routes.

property callbacks: Callable

The functions called upon receiving an event.

property shards: dict[int, Client]

The gateway clients againt their ids.

property cache: GatewayCache

The dispatch cache.

property voices: dict[Snowflake, Client]

The voice clients.

ready()

Return type:

Source:

Wait until all shards are ready to dispatch events.

get_global_application_commands(application_id, /, **fields)

Use http.routes.get_global_application_commands.

Parameters:

with_localizations – Source: with_localizations

Return type:

Source:

create_global_application_command(application_id, /, **fields)

Use http.routes.create_global_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

Source:

get_global_application_command(application_id, command_id, /, **fields)

Return type:

Source:

Use http.routes.get_global_application_command.

update_global_application_command(application_id, command_id, /, **fields)

Use http.routes.update_global_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• default_permission – Source: default_permission

• nsfw – Source: nsfw

Return type:

Source:

delete_global_application_command(application_id, command_id, /, **fields)

Return type:

Source:

Use http.routes.delete_global_application_command.

update_all_global_application_commands(application_id, /, commands)

Return type:

Source:

Use http.routes.update_all_global_application_commands.

get_guild_application_commands(application_id, guild_id, /, **fields)

Parameters:

localized – Source: with_localizations

Use http.routes.get_guild_application_commands.

Return type:

Source:

create_guild_application_command(application_id, guild_id, /, **fields)

Use http.routes.create_guild_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• default_permission – Source: default_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

Source:

get_guild_application_command(application_id, guild_id, command_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_application_command.

update_guild_application_command(application_id, guild_id, command_id, /, **fields)

Use http.routes.update_guild_application_command.

Parameters:

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• default_permission – Source: default_permission

• nsfw – Source: nsfw

Return type:

Source:

delete_guild_application_command(application_id, guild_id, command_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_application_command.

update_all_guild_application_commands(application_id, guild_id, /, **fields)

Use http.routes.update_all_guild_application_commands.

Parameters:

• id – Source: id

• name – Source: name

• name_localizations – Source: name_localizations

• description – Source: description

• description_localizations – Source: description_localizations

• options – Source: options

• default_member_permissions – Source: default_member_permissions

• dm_permission – Source: dm_permission

• default_permission – Source: default_permission

• type – Source: type

• nsfw – Source: nsfw

Return type:

Source:

get_guild_application_command_permissions(application_id, guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_application_command_permissions.

get_application_command_permissions(application_id, guild_id, command_id, /, **fields)

Return type:

Source:

Use http.routes.get_application_command_permissions.

update_application_command_permissions(application_id, guild_id, command_id, /, **fields)

Use http.routes.update_application_command_permissions.

Parameters:

permissions – Source: permissions

Return type:

Source:

create_interaction_response(interaction_id, interaction_token, /, **fields)

Return type:

Source:

Use http.routes.create_interaction_response.

get_interaction_response(application_id, interaction_token, /, **fields)

Use http.routes.get_interaction_response.

Parameters:

thread_id – Source: thread_id

Return type:

Source:

update_interaction_response(application_id, interaction_token, /, **fields)

Use http.routes.update_interaction_response.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

delete_interaction_response(application_id, interaction_token, /, **fields)

Return type:

Source:

Use http.routes.delete_interaction_response.

create_followup_message(application_id, interaction_token, /, **fields)

Use http.routes.create_followup_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• username – Source: username

• avatar_url – Source: avatar_url

• tts – Source: tts

• components – Source: components

• files – Source: files[n]

• flags – Source: flags

• thread_name – Source: thread_name

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

get_followup_message(application_id, interaction_token, message_id, /, **fields)

Return type:

Source:

Use http.routes.get_followup_message.

update_followup_message(application_id, interaction_token, message_id, /, **fields)

Use http.routes.update_followup_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

delete_followup_message(application_id, interaction_token, message_id, /, **fields)

Return type:

Source:

Use http.routes.delete_followup_message.

get_application_role_connection_metadata(application_id, /, **fields)

Return type:

Source:

Use http.routes.get_application_role_connection_metadata.

update_application_role_connection_metadata(application_id, /, **fields)

Return type:

Source:

Use http.routes.update_application_role_connection_metadata.

get_guild_audit_log(guild_id, /, **fields)

Use http.routes.get_guild_audit_log.

Parameters:

• user_id – Source: user_id

• action_type – Source: action_type

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

Source:

get_guild_auto_moderation_rules(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_auto_moderation_rules.

get_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Return type:

Source:

Use http.routes.get_auto_moderation_rule.

create_auto_moderation_rule(guild_id, /, **fields)

Use http.routes.create_auto_moderation_rule.

Parameters:

• name – Source: name

• event_type – Source: event_type

• trigger_type – Source: trigger_type

• enabled – Source: enabled

• exempt_roles – Source: exempt_roles

• exempt_channels – Source: exempt_channels

• trigger_metadata – Source: trigger_metadata

• actions – Source: actions

Return type:

Source:

update_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Use http.routes.update_auto_moderation_rule.

Parameters:

• name – Source: name

• event_type – Source: event_type

• enabled – Source: enabled

• exempt_roles – Source: exempt_roles

• exempt_channels – Source: exempt_channels

• trigger_metadata – Source: trigger_metadata

• actions – Source: actions

Return type:

Source:

delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, /, **fields)

Return type:

Source:

Use http.routes.delete_auto_moderation_rule.

get_channel(channel_id, /, **fields)

Return type:

Source:

Use http.routes.get_channel.

update_channel(channel_id, /, **fields)

Use http.routes.update_channel.

Parameters:

• name – Source: name

• archived – Source: archived

• auto_archive_duration – Source: auto_archive_duration

• locked – Source: locked

• invitable – Source: invitable

• rate_limit_per_user – Source: rate_limit_per_user

• flags – Source: flags

• applied_tags – Source: applied_tags

Return type:

Source:

delete_channel(channel_id, /, **fields)

Return type:

Source:

Use http.routes.delete_channel.

get_messages(channel_id, /, **fields)

Use http.routes.get_messages.

Parameters:

• around – Source: around

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

Source:

get_message(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.get_message.

create_message(channel_id, /, **fields)

Use http.routes.create_message.

Parameters:

• content – Source: content

• nonce – Source: nonce

• tts – Source: tts

• message_reference – Source: message_reference

• sticker_ids – Source: sticker_ids

• files – Source: files[n]

• flags – Source: flags

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• components – Source: components

• attachments – Source: attachments

Return type:

Source:

create_message_crosspost(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.create_message_crosspost.

create_reaction(channel_id, message_id, emoji, /, **fields)

Return type:

Source:

Use http.routes.create_reaction.

delete_own_reaction(channel_id, message_id, emoji, /, **fields)

Return type:

Source:

Use http.routes.delete_own_reaction.

delete_user_reaction(channel_id, message_id, emoji, user_id, /, **fields)

Return type:

Source:

Use http.routes.delete_user_reaction.

get_reactions(channel_id, message_id, emoji, /, **fields)

Use http.routes.get_reactions.

Parameters:

• after – Source: after

• limit – Source: limit

Return type:

Source:

delete_all_reactions(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.delete_all_reactions.

delete_all_emoji_reactions(channel_id, message_id, emoji, /, **fields)

Return type:

Source:

Use http.routes.delete_all_emoji_reactions.

update_message(channel_id, message_id, /, **fields)

Use http.routes.update_message.

Parameters:

• content – Source: content

• flags – Source: flags

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

delete_message(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.delete_message.

delete_messages(channel_id, /, **fields)

Use http.routes.delete_messages.

Parameters:

message_ids – Source: messages

Return type:

Source:

update_channel_permissions(channel_id, overwrite_id, /, **fields)

Parameters:

• allow – Source: allow

• deny – Source: deny

• type – Source: type

Use http.routes.update_channel_permissions.

Return type:

Source:

get_channel_invites(channel_id, /, **fields)

Return type:

Source:

Use http.routes.get_channel_invites.

create_channel_invite(channel_id, /, **fields)

Use http.routes.create_channel_invite.

Parameters:

• max_age – Source: max_age

• max_uses – Source: max_uses

• temporary – Source: temporary

• unique – Source: unique

• target_type – Source: target_type

• target_user_id – Source: target_user_id

• target_application_id – Source: target_application_id

Return type:

Source:

delete_channel_permission(channel_id, overwrite_id, /, **fields)

Return type:

Source:

Use http.routes.delete_channel_permission.

create_channel_follow(channel_id, /, **fields)

Use http.routes.create_channel_follow.

Parameters:

webhook_channel_id – Source: webhook_channel_id

Return type:

Source:

create_typing_indicator(channel_id, /, **fields)

Return type:

Source:

Use http.routes.create_typing_indicator.

get_channel_pins(channel_id, /, **fields)

Return type:

Source:

Use http.routes.get_channel_pins.

create_channel_pin(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.create_channel_pin.

delete_channel_pin(channel_id, message_id, /, **fields)

Return type:

Source:

Use http.routes.delete_channel_pin.

create_channel_recipient(channel_id, user_id, /, **fields)

Use http.routes.create_channel_recipient.

Parameters:

• access_token – Source: access_token

• nick – Source: nick

Return type:

Source:

delete_channel_recipient(channel_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.delete_channel_recipient.

create_message_thread(channel_id, message_id, /, **fields)

Use http.routes.create_message_thread.

Parameters:

• name – Source: name

• auto_archive_duration – Source: auto_archive_duration

• rate_limit_per_user – Source: rate_limit_per_user

Return type:

Source:

create_thread(channel_id, /, **fields)

Use http.routes.create_thread.

Parameters:

• name – Source: name

• auto_archive_duration – Source: auto_archive_duration

• type – Source: type

• invitable – Source: invitable

• rate_limit_per_user – Source: rate_limit_per_user

• message – Source: message

• applied_tags – Source: applied_tags

create_self_thread_member(channel_id, /, **fields)

Return type:

Source:

Use http.routes.create_self_thread_member.

create_thread_member(channel_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.create_thread_member.

delete_self_thread_member(channel_id, /, **fields)

Return type:

Source:

Use http.routes.delete_self_thread_member.

delete_thread_member(channel_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.delete_thread_member.

get_thread_member(channel_id, user_id, /, **fields)

Use http.routes.get_thread_member.

Parameters:

with_member – Source: with_member

Return type:

Source:

get_thread_members(channel_id, /, **fields)

When with_member is set to true, the results will be paginated and each thread member object will include a member field containing a guild member object.

Parameters:

• with_member – Source: with_member

• after – Source: after

• limit – Source: limit

Return type:

Source:

Use http.routes.get_thread_members.

get_public_archived_threads(channel_id, /, **fields)

Use http.routes.get_public_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

Source:

get_private_archived_threads(channel_id, /, **fields)

Use http.routes.get_private_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

Source:

get_self_private_archived_threads(channel_id, /, **fields)

Use http.routes.get_self_private_archived_threads.

Parameters:

• before – Source: before

• limit – Source: limit

Return type:

Source:

get_guild_emojis(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_emojis.

get_guild_emoji(guild_id, emoji_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_emoji.

create_guild_emoji(guild_id, /, **fields)

Use http.routes.create_guild_emoji.

Parameters:

• name – Source: name

• image – Source: image

• roles – Source: roles

Return type:

Source:

update_guild_emoji(guild_id, emoji_id, /, **fields)

Use http.routes.update_guild_emoji.

Parameters:

• name – Source: name

• roles – Source: roles

Return type:

Source:

delete_guild_emoji(guild_id, emoji_id, /, **fields)

Use http.routes.delete_guild_emoji.

Parameters:

• name – Source: name

• roles – Source: roles

Return type:

Source:

create_guild(**fields)

Use http.routes.create_guild.

Parameters:

• name – Source: name

• region – Source: region

• icon – Source: icon

• verification_level – Source: verification_level

• default_message_notifications – Source: default_message_notifications

• explicit_content_filter – Source: explicit_content_filter

• afk_channel_id – Source: afk_channel_id

• afk_timeout – Source: afk_timeout

• system_channel_id – Source: system_channel_id

• system_channel_flags – Source: system_channel_flags

• roles – Source: roles

• channels – Source: channels

Return type:

Source:

get_guild(guild_id, /, **fields)

Use http.routes.get_guild.

Parameters:

with_counts – Source: with_counts

Return type:

Source:

get_guild_preview(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_preview.

update_guild(guild_id, /, **fields)

Use http.routes.update_guild.

Parameters:

• name – Source: name

• region – Source: region

• verification_level – Source: verification_level

• default_message_notifications – Source: default_message_notifications

• explicit_content_filter – Source: explicit_content_filter

• afk_channel_id – Source: afk_channel_id

• afk_timeout – Source: afk_timeout

• icon – Source: icon

• owner_id – Source: owner_id

• splash – Source: splash

• discovery_splash – Source: discovery_splash

• banner – Source: banner

• system_channel_id – Source: system_channel_id

• system_channel_flags – Source: system_channel_flags

• rules_channel_id – Source: rules_channel_id

• public_updates_channel_id – Source: public_updates_channel_id

• preferred_locale – Source: preferred_locale

• features – Source: features

• description – Source: description

• premium_progress_bar_enabled – Source: premium_progress_bar_enabled

Return type:

Source:

delete_guild(guild_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild.

get_guild_channels(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_channels.

create_guild_channel(guild_id, /, **fields)

Use http.routes.create_guild_channel.

Parameters:

• name – Source: name

• type – Source: type

• topic – Source: topic

• bitrate – Source: bitrate

• user_limit – Source: user_limit

• rate_limit_per_user – Source: rate_limit_per_user

• position – Source: position

• parent_id – Source: parent_id

• nsfw – Source: nsfw

• rtc_region – Source: rtc_region

• video_quality_mode – Source: video_quality_mode

• default_auto_archive_duration – Source: default_auto_archive_duration

• default_sort_order – Source: default_sort_order

• permission_overwrites – Source: permission_overwrites

• default_reaction_emoji – Source: default_reaction_emoji

• available_tags – Source: available_tags

Return type:

Source:

update_guild_channel_positions(guild_id, /, positions)

Use http.routes.update_guild_channel_positions.

Parameters:

positions (Source:) – An array of objects.

Return type:

Source:

Each element of positions must abide to the following:

Parameters:

• id – Source: id

• position – Source: position

• lock_permissions – Source: lock_permissions

• parent_id – Source: parent_id

get_active_guild_threads(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_active_guild_threads.

get_guild_member(guild_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_member.

get_guild_members(guild_id, /, **fields)

Use http.routes.get_guild_members.

Parameters:

• limit – Source: limit

• after – Source: after

Return type:

Source:

search_guild_members(guild_id, /, **fields)

Use http.routes.search_guild_members.

Parameters:

• query – Source: query

• limit – Source: limit

Return type:

Source:

create_guild_member(guild_id, user_id, /, **fields)

Use http.routes.create_guild_member.

Parameters:

• access_token – Source: access_token

• nick – Source: nick

• roles – Source: roles

• mute – Source: mute

• deaf – Source: deaf

Return type:

Source:

update_guild_member(guild_id, user_id, /, **fields)

Use http.routes.update_guild_member.

Parameters:

• nick – Source: nick

• roles – Source: roles

• mute – Source: mute

• deaf – Source: deaf

• channel_id – Source: channel_id

• communication_disabled_until – Source: communication_disabled_until

• flags – Source: flags

Return type:

Source:

update_self_guild_member(guild_id, /, **fields)

Use http.routes.update_self_guild_member.

Parameters:

nick – Source: nick

Return type:

Source:

create_guild_member_role(guild_id, user_id, role_id, /, **fields)

Return type:

Source:

Use http.routes.create_guild_member_role.

delete_guild_member_role(guild_id, user_id, role_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_member_role.

delete_guild_member(guild_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_member.

get_guild_bans(guild_id, /, **fields)

Use http.routes.get_guild_bans.

Parameters:

• limit – Source: limit

• before – Source: before

• after – Source: after

Return type:

Source:

get_guild_ban(guild_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_ban.

create_guild_ban(guild_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.create_guild_ban.

delete_guild_ban(guild_id, user_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_ban.

get_guild_roles(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_roles.

create_guild_role(guild_id, /, **fields)

Use http.routes.create_guild_role.

Parameters:

• name – Source: name

• permissions – Source: permissions

• color – Source: color

• hoist – Source: hoist

• icon – Source: icon

• unicode_emoji – Source: unicode_emoji

• mentionable – Source: mentionable

Return type:

Source:

update_guild_role_positions(guild_id, /, positions)

Use http.routes.update_guild_role_positions.

Parameters:

positions (Source:) – An array of objects.

Return type:

Source:

Each element of positions must abide to the following:

Parameters:

• id – Source: id

• position – Source: position

update_guild_role(guild_id, role_id, /, **fields)

Use http.routes.update_guild_role.

Parameters:

• name – Source: name

• permissions – Source: permissions

• color – Source: color

• hoist – Source: hoist

• icon – Source: icon

• unicode_emoji – Source: unicode_emoji

• mentionable – Source: mentionable

Return type:

Source:

update_guild_mfa_level(guild_id, /, **fields)

Use http.routes.update_guild_mfa_level.

Parameters:

level – Source: level

Return type:

Source:

delete_guild_role(guild_id, role_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_role.

get_guild_prune_count(guild_id, /, **fields)

Use http.routes.get_guild_prune_count.

Parameters:

• days – Source: days

• include_roles – Source: include_roles

Return type:

Source:

start_guild_prune(guild_id, /, **fields)

Use http.routes.start_guild_prune.

Parameters:

• days – Source: days

• compute_prune_count – Source: compute_prune_count

• include_roles – Source: include_roles

• reason – Source: reason

Return type:

Source:

get_guild_voice_regions(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_voice_regions.

get_guild_invites(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_invites.

get_guild_integrations(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_integrations.

delete_guild_integration(guild_id, integration_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_integration.

get_guild_widget_settings(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_widget_settings.

update_guild_widget(guild_id, /, **fields)

Return type:

Source:

Use http.routes.update_guild_widget.

get_guild_widget(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_widget.

get_guild_vanity_url(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_vanity_url.

get_guild_widget_image(guild_id, /, **fields)

Use http.routes.get_guild_widget_image.

Parameters:

style – Source: style

Return type:

Source:

get_guild_welcome_screen(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_welcome_screen.

update_guild_welcome_screen(guild_id, /, **fields)

Use http.routes.update_guild_welcome_screen.

Parameters:

• enabled – Source: enabled

• description – Source: description

• welcome_channels – Source: welcome_channels

Return type:

Source:

get_guild_onboarding(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_onboarding.

update_self_voice_state(guild_id, /, **fields)

Use http.routes.update_self_voice_state.

Parameters:

• channel_id – Source: channel_id

• suppress – Source: suppress

• request_to_speak_timestamp – Source: request_to_speak_timestamp

Return type:

Source:

update_voice_state(guild_id, user_id, /, **fields)

Use http.routes.update_voice_state.

Parameters:

• channel_id – Source: channel_id

• suppress – Source: suppress

• request_to_speak_timestamp – Source: request_to_speak_timestamp

Return type:

Source:

get_guild_scheduled_events(guild_id, /, **fields)

Use http.routes.get_guild_scheduled_events.

Parameters:

with_user_count – Source: with_user_count

Return type:

Source:

create_guild_scheduled_event(guild_id, /, **fields)

Use http.routes.create_guild_scheduled_event.

Parameters:

• channel_id – Source: channel_id

• entity_metadata – Source: entity_metadata

• name – Source: name

• privacy_level – Source: privacy_level

• scheduled_start_time – Source: scheduled_start_time

• scheduled_end_time – Source: scheduled_end_time

• description – Source: description

• entity_type – Source: entity_type

• image – Source: image

Return type:

Source:

get_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.get_guild_scheduled_event.

Parameters:

with_user_count – Source: with_user_count

Return type:

Source:

update_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Use http.routes.update_guild_scheduled_event.

Parameters:

• channel_id – Source: channel_id

• entity_metadata – Source: entity_metadata

• name – Source: name

• privacy_level – Source: privacy_level

• scheduled_start_time – Source: scheduled_start_time

• scheduled_end_time – Source: scheduled_end_time

• description – Source: description

• entity_type – Source: entity_type

• status – Source: status

• image – Source: image

Return type:

Source:

delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, /, **fields)

Return type:

Source:

Use http.routes.delete_guild_scheduled_event.

get_guild_scheduled_event_users(guild_id, guild_scheduled_event_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_scheduled_event_users

get_guild_template(template_code, /, **fields)

Return type:

Source:

Use http.routes.get_guild_template.

create_guild_via_guild_template(template_code, /, **fields)

Use http.routes.create_guild_via_guild_template.

Parameters:

• name – Source: name

• icon – Source: icon

Return type:

Source:

get_guild_templates(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_templates.

create_guild_template(guild_id, /, **fields)

Use http.routes.create_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

Source:

sync_guild_template(guild_id, template_code, /, **fields)

Return type:

Source:

Use http.routes.sync_guild_template.

update_guild_template(guild_id, template_code, /, **fields)

Use http.routes.update_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

Source:

delete_guild_template(guild_id, template_code, /, **fields)

Use http.routes.delete_guild_template.

Parameters:

• name – Source: name

• description – Source: description

Return type:

Source:

get_invite(invite_code, /, **fields)

Use http.routes.get_invite.

Parameters:

• with_counts – Source: with_counts

• with_expiration – Source: with_expiration

• guild_scheduled_event_id – Source: guild_scheduled_event_id

Return type:

Source:

delete_invite(invite_code, /, **fields)

Return type:

Source:

Use http.routes.delete_invite.

create_stage_instance(**fields)

Use http.routes.create_stage_instance.

Parameters:

• channel_id – Source: channel_id

• topic – Source: topic

• privacy_level – Source: privacy_level

• send_start_notification – Source: send_start_notification

Return type:

Source:

get_stage_instance(channel_id, /, **fields)

Return type:

Source:

Use http.routes.get_stage_instance.

update_stage_instance(channel_id, /, **fields)

Use http.routes.update_stage_instance.

Parameters:

• topic – Source: topic

• privacy_level – Source: privacy_level

Return type:

Source:

delete_stage_instance(channel_id, /, **fields)

Use http.routes.delete_stage_instance.

Parameters:

• topic – Source: topic

• privacy_level – Source: privacy_level

Return type:

Source:

get_sticker(sticker_id, /, **fields)

Return type:

Source:

Use http.routes.get_sticker.

get_sticker_packs(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_sticker_packs.

get_guild_stickers(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_stickers.

get_guild_sticker(guild_id, sticker_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_sticker.

create_guild_sticker(guild_id, /, **fields)

Use http.routes.create_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

• file – Source: file

Return type:

Source:

update_guild_sticker(guild_id, sticker_id, /, **fields)

Use http.routes.update_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

Return type:

Source:

delete_guild_sticker(guild_id, sticker_id, /, **fields)

Use http.routes.delete_guild_sticker.

Parameters:

• name – Source: name

• description – Source: description

• tags – Source: tags

Return type:

Source:

get_self_user(**fields)

Return type:

Source:

Use http.routes.get_self_user.

get_user(user_id, /, **fields)

Return type:

Source:

Use http.routes.get_user.

update_self_user(**fields)

Use http.routes.update_self_user.

Parameters:

• username – Source: username

• avatar – Source: avatar

Return type:

Source:

get_self_guilds(**fields)

Use http.routes.get_self_guilds.

Parameters:

• before – Source: before

• after – Source: after

• limit – Source: limit

Return type:

Source:

get_self_guild_member(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_self_guild_member.

delete_self_guild_member(guild_id, /, **fields)

Return type:

Source:

Use http.routes.delete_self_guild_member.

create_self_channel(**fields)

Use http.routes.create_self_channel.

Parameters:

recipient_id – Source: recipient_id

get_self_connections(**fields)

Return type:

Source:

Use http.routes.get_self_connections.

get_self_application_role_connection(application_id, /, **fields)

Return type:

Source:

Use http.routes.get_self_application_role_connection.

update_self_application_role_connection(application_id, /, **fields)

Return type:

Source:

Use http.routes.update_self_application_role_connection.

get_voice_regions(**fields)

Return type:

Source:

Use http.routes.get_voice_regions.

create_webhook(channel_id, /, **fields)

Use http.routes.create_webhook.

Parameters:

• name – Source: name

• avatar – Source: avatar

Return type:

Source:

get_channel_webhooks(channel_id, /, **fields)

Return type:

Source:

Use http.routes.get_channel_webhooks.

get_guild_webhooks(guild_id, /, **fields)

Return type:

Source:

Use http.routes.get_guild_webhooks.

get_webhook(webhook_id, /, **fields)

Return type:

Source:

Use http.routes.get_webhook.

get_webhook_via_token(webhook_id, webhook_token, /, **fields)

Return type:

Source:

Use http.routes.get_webhook_via_token.

update_webhook(webhook_id, /, **fields)

Use http.routes.update_webhook.

Parameters:

• name – Source: name

• avatar – Source: avatar

• channel_id – Source: channel_id

Return type:

Source:

update_webhook_via_token(webhook_id, webhook_token, /, **fields)

Return type:

Source:

Use http.routes.update_webhook_via_token.

delete_webhook(webhook_id, /, **fields)

Return type:

Source:

Use http.routes.delete_webhook.

delete_webhook_via_token(webhook_id, webhook_token, /, **fields)

Return type:

Source:

Use http.routes.delete_webhook_via_token.

create_webhook_message(webhook_id, webhook_token, /, **fields)

Use http.routes.create_webhook_message.

Parameters:

• wait – Source: wait

• thread_id – Source: thread_id

• content – Source: content

• username – Source: username

• avatar_url – Source: avatar_url

• tts – Source: tts

• components – Source: components

• files – Source: files[n]

• flags – Source: flags

• thread_name – Source: thread_name

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

get_webhook_message(webhook_id, webhook_token, message_id, /, **fields)

Use http.routes.get_webhook_message.

Parameters:

thread_id – Source: thread_id

Return type:

Source:

update_webhook_message(webhook_id, webhook_token, /, **fields)

Use http.routes.update_webhook_message.

Parameters:

• thread_id – Source: thread_id

• content – Source: content

• components – Source: components

• files – Source: files[n]

• embeds – Source: embeds

• allowed_mentions – Source: allowed_mentions

• attachments – Source: attachments

Return type:

Source:

delete_webhook_message(webhook_id, webhook_token, message_id, /, **fields)

Use http.routes.delete_webhook_message.

Parameters:

thread_id – Source: thread_id

Return type:

Source:

get_self_application_information(**fields)

Return type:

Source:

Use http.routes.get_self_application_information.

get_self_authorization_information(**fields)

Return type:

Source:

Use http.routes.get_self_authorization_information.

get_skus(application_id, /, **fields)

Use http.routes.get_skus.

get_entitlements(application_id, /, **fields)

Use http.routes.get_entitlements.

create_entitlement(application_id, /, **fields)

Use http.routes.create_entitlement.

delete_entitlement(application_id, entitlement_id, /, **fields)

Use http.routes.delete_entitlement.

wait(Event, check=None, /, timeout=None)

Setup waiting for a specific event.

Parameters:

• Event – Any class of the first argument of callback.

• check – Called the same way as callback. Should return bool indicating whether to set the event.

• timeout (Source:) – Maximum amount of seconds to wait before setting the event.

Return type:

Source:

Returns:

The inputs to the matched event.

def check(event):
    return event.message.author.id == client.cache.user.id and event.message.content == 'pass'

task = asyncio.create_task(aiocord.events.CreateMessage, check, timeout = 10)

await client.create_message(channel_id, content = 'pass')

event = await task # the corresponding CreateMessage event

request_guild_members(**fields)

Return type:

Source:

Use gateway.client.Client.request_guild_members() for the respective guild’s shard.

create_self_voice_state(**fields)

Return type:

Source:

Use gateway.client.Client.update_voice_state() for the respective guild’s shard.

Warning

This does not create a voice client, use start_voice() for that.

update_self_presence(**fields)

Return type:

Source:

Use gateway.client.Client.update_presence() for all shards.

start(intents=None, shard_ids=None, shard_count=None, present=None)

Start shard connections.

Parameters:

• intents (Source:) – The intents to identify with.

• shard_ids (Source:) – The shard ids to connect to. If not specified, the recommended are used.

• shard_count (Source:) – The total number of shards for the client. If not specified, the recommended is used.

• present (Source:) – A callable that, when called, returns the desired presence.

Return type:

Source:

stop()

Return type:

Source:

Stop all shard connections and their products and close the session.

start_voice(guild_id, channel_id)

Join a voice channel and start the voice connection lifecycle.

Parameters:

• guild_id (Source:) – The id of the joining channel’s guild.

• channel_id (Source:) – The id of the joining channel.

Return type:

Source:

stop_voice(guild_id, /, *, force=False)

Stop the voice connection lifecycle and leave the voice channel.

Parameters:

• guild_id (Source:) – The id of the leaving channel’s guild.

• force (Source:) – Whether to not send the gateway request for leaving the channel before stopping the voice client.

Return type:

Source:

events

class aiocord.events.Ready

Bases: NamedTuple

Dispatched on enums.GatewayEvent.ready.

class aiocord.events.UpdateApplicationCommandPermission(guild: Guild, application_command_permissions: GuildApplicationCommandPermissions)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_application_command_permissions.

guild: Source:

Source	Target
guild_id	id

application_command_permissions: Source:

Source	Target
body

class aiocord.events.CreateAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_auto_moderation_rule.

guild: Source:

Source	Target
guild_id	id

auto_moderation_rule: Source:

Source	Target
body

class aiocord.events.UpdateAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_auto_moderation_rule.

guild: Source:

Source	Target
guild_id	id

auto_moderation_rule: Source:

Source	Target
body

class aiocord.events.DeleteAutoModerationRule(guild: Guild, auto_moderation_rule: AutoModerationRule)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_auto_moderation_rule.

guild: Source:

Source	Target
guild_id	id

auto_moderation_rule: Source:

Source	Target
body

class aiocord.events.ExecuteAutoModerationRule(guild: Guild, auto_moderation_action: AutoModerationAction, auto_moderation_rule: AutoModerationRule, user: User, channel: Channel, source_message: Message, system_message: Message, matched_keyword: str, matched_content: str)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.execute_auto_moderation_action.

guild: Source:

Source	Target
guild_id	id

auto_moderation_action: Source:

Source	Target
action

auto_moderation_rule: Source:

Source	Target
rule_id	id
rule_trigger_type	trigger_type

user: Source:

Source	Target
user_id	id

channel: Source:

Source	Target
channel_id	id

source_message: Source:

Source	Target
message_id	id
content	content

system_message: Source:

Source	Target
alert_system_message_id	id

matched_keyword: Source:

Source	Target
matched_keyword

matched_content: Source:

Source	Target
matched_content

class aiocord.events.CreateChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_channel.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
body

class aiocord.events.UpdateChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_channel.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
body

class aiocord.events.DeleteChannel(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_channel.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
body

class aiocord.events.CreateThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_thread.

guild: Source:

Source	Target
guild_id	id

thread: Source:

Source	Target
body

class aiocord.events.UpdateThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread.

guild: Source:

Source	Target
guild_id	id

thread: Source:

Source	Target
body

class aiocord.events.DeleteThread(guild: Guild, thread: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_thread.

guild: Source:

Source	Target
guild_id	id

thread: Source:

Source	Target
body

class aiocord.events.SyncThreads(guild: Guild, threads: Collection[Channel])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.sync_threads.

guild: Source:

Source	Target
guild_id	id

threads: Source:

Source	Target
threads

class aiocord.events.UpdateThreadMember(guild: Guild, thread: Channel, thread_member: ThreadMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread_member.

guild: Source:

Source	Target
guild_id	id

thread: Source:

Source	Target
id	id

thread_member: Source:

Source	Target
body

class aiocord.events.UpdateThreadMembers(guild: Guild, thread: Channel, created_thread_members: Collection[ThreadMember], deleted_thread_members: Collection[ThreadMember])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_thread_members.

guild: Source:

Source	Target
guild_id	id

thread: Source:

Source	Target
id	id

created_thread_members: Source:

Source	Target
added_members

deleted_thread_members: Source:

Source	Target
removed_member_ids	id

class aiocord.events.UpdateChannelPins(guild: Guild, channel: Channel, timestamp: ISO8601Timestamp)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_channel_pins.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

timestamp: Source:

Source	Target
last_pin_timestamp

class aiocord.events.CreateGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild when the guild is created.

guild: Source:

Source	Target
body

class aiocord.events.AvailableGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild when the guild is available.

guild: Source:

Source	Target
body

class aiocord.events.DeleteGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild when the guild is deleted.

guild: Source:

Source	Target
body

class aiocord.events.UnavailableGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent. when the guild is unavailable.

guild: Source:

Source	Target
body

class aiocord.events.UpdateGuild(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild.

Copiable with data before updating.

guild: Source:

Source	Target
body

class aiocord.events.CreateGuildAuditLogEntry(guild: Guild, guild_audit_log_entry: AuditLogEntry)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_audit_log_entry.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_audit_log_entry: Source:

Source	Target
body

class aiocord.events.CreateGuildBan(guild: Guild, user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_ban.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

user: Source:

Source	Target
user

class aiocord.events.DeleteGuildBan(guild: Guild, user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_ban.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

user: Source:

Source	Target
user

class aiocord.events.UpdateGuildEmojis(guild: Guild, emojis: Collection[Emoji])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_emojis.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

emojis: Source:

Source	Target
emojis

class aiocord.events.UpdateGuildStickers(guild: Guild, emojis: Collection[Emoji])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_stickers.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

emojis: Source:

Source	Target
stickers

class aiocord.events.UpdateGuildIntegrations(guild: Guild)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_integrations.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

class aiocord.events.CreateGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_member.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
body

class aiocord.events.DeleteGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_member.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
user	user

class aiocord.events.UpdateGuildMember(guild: Guild, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_member.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
body

class aiocord.events.ReceiveGuildMembers(guild: Guild, guild_members: Collection[GuildMember], guild_presences: Collection[Presence], chunk_index: int, chunk_indexes: set[int])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.receive_guild_members.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_members: Source:

Source	Target
members

guild_presences: Source:

Source	Target
members

chunk_index: Source:

Source	Target
chunk_index

chunk_indexes: Source:

The remaining indexes (receiving is complete when this is empty).

Source	Target
internal

class aiocord.events.CreateGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_role.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_role: Source:

Source	Target
role

class aiocord.events.UpdateGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_role.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_role: Source:

Source	Target
role

class aiocord.events.DeleteGuildRole(guild: Guild, guild_role: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_role.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_role: Source:

Source	Target
role_id	id

class aiocord.events.CreateGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_scheduled_event.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_scheduled_event: Source:

Source	Target
body

class aiocord.events.UpdateGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_guild_scheduled_event.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_scheduled_event: Source:

Source	Target
body

class aiocord.events.DeleteGuildScheduledEvent(guild: Guild, guild_scheduled_event: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_scheduled_event.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_scheduled_event: Source:

Source	Target
body

class aiocord.events.CreateGuildScheduledEventUser(guild: Guild, guild_scheduled_event: GuildMember, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_guild_scheduled_event_user.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_scheduled_event: Source:

Source	Target
guild_scheduled_event_id	id

guild_member: Source:

Source	Target
user_id	user’s id

class aiocord.events.DeleteGuildScheduledEventUser(guild: Guild, guild_scheduled_event: GuildMember, guild_member: GuildMember)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_guild_scheduled_event_user.

Copiable with data before updating.

guild: Source:

Source	Target
guild_id	id

guild_scheduled_event: Source:

Source	Target
guild_scheduled_event_id	id

guild_member: Source:

Source	Target
user_id	user’s id

class aiocord.events.CreateIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_integration.

guild: Source:

Source	Target
guild_id	id

integration: Source:

Source	Target
body

class aiocord.events.UpdateIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_integration.

guild: Source:

Source	Target
guild_id	id

integration: Source:

Source	Target
body

class aiocord.events.DeleteIntegration(guild: Guild, integration: Integration)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_integration.

guild: Source:

Source	Target
guild_id	id

integration: Source:

Source	Target
body

class aiocord.events.CreateInvite(guild: Guild, channel: Channel, invite: Invite)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_invite.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

invite: Source:

Source	Target
body

class aiocord.events.DeleteInvite(guild: Guild, channel: Channel, invite: Invite)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_invite.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

invite: Source:

Source	Target
code	code

class aiocord.events.CreateMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_message.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id
last_message_id	last_message_id

message: Source:

Source	Target
body

class aiocord.events.UpdateMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_message.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id
last_message_id	last_message_id

message: Source:

Source	Target
body

class aiocord.events.DeleteMessage(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_message.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id
last_message_id	last_message_id

message: Source:

Source	Target
id	id

class aiocord.events.DeleteMessages(guild: Guild, channel: Channel, messages: Collection[Message])

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_messages.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id
last_message_id	last_message_id

messages: Source:

Source	Target
ids (each)	id

class aiocord.events.CreateMessageReaction(guild: Guild, guild_member: GuildMember, user: User, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_message_reaction.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
member

user: Source:

Source	Target
user_id	id

channel: Source:

Source	Target
channel_id	id

message: Source:

Source	Target
message_id	id

emoji: Source:

Source	Target
emoji

class aiocord.events.DeleteMessageReaction(guild: Guild, guild_member: GuildMember, user: User, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_message_reaction.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
user_id	user’s id

user: Source:

Source	Target
user_id	id

channel: Source:

Source	Target
channel_id	id

message: Source:

Source	Target
message_id	id

emoji: Source:

Source	Target
emoji

class aiocord.events.DeleteAllMessageReactions(guild: Guild, channel: Channel, message: Message)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_all_message_reactions.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

message: Source:

Source	Target
message_id	id

class aiocord.events.DeleteAllMessageEmojiReactions(guild: Guild, channel: Channel, message: Message, emoji: Emoji)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_all_message_emoji_reactions.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

message: Source:

Source	Target
message_id	id

emoji: Source:

Source	Target
emoji

class aiocord.events.UpdatePresence(guild: Guild, presence: Presence)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_presence.

guild: Source:

Source	Target
guild_id	id

presence: Source:

Source	Target
body

class aiocord.events.CreateTypingIndicator(guild: Guild, guild_member: GuildMember, user: GuildMember, channel: Channel, timestamp: Timestamp)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_typing_indicator.

guild: Source:

Source	Target
guild_id	id

guild_member: Source:

Source	Target
member

user: Source:

Source	Target
user_id	id

channel: Source:

Source	Target
channel_id	id

timestamp: Source:

Source	Target
timestamp

class aiocord.events.UpdateSelfUser(user: User)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_self_user.

user: Source:

Source	Target
body

class aiocord.events.UpdateVoiceState(guild: Guild, voice_state: VoiceState, voice: Client | None)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_voice_state.

guild: Source:

Source	Target
guild_id	id

voice_state: Source:

Source	Target
body

voice: Source:

The self’s voice client.

class aiocord.events.UpdateVoiceServer(guild: Guild, token: str, uri: str)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_voice_server.

guild: Source:

Source	Target
guild_id	id

token: Source:

Source	Target
token

uri: Source:

Source	Target
uri

class aiocord.events.UpdateWebhooks(guild: Guild, channel: Channel)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_webhooks.

guild: Source:

Source	Target
guild_id	id

channel: Source:

Source	Target
channel_id	id

class aiocord.events.CreateInteraction(interaction: Interaction)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_interaction.

interaction: Source:

Source	Target
body

class aiocord.events.CreateStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.create_stage_instance.

stage_instance: Source:

Source	Target
body

class aiocord.events.UpdateStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.update_stage_instance.

stage_instance: Source:

Source	Target
body

class aiocord.events.DeleteStageInstance(stage_instance: StageInstance)

Bases: NamedTuple

Dispatched on enums.GatewayEvent.delete_stage_instance.

stage_instance: Source:

Source	Target
body

class aiocord.events.EnterVoice(guild: Guild, user: GuildMember)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.enter.

guild: Source:

Source	Target
guild_id	id

user: Source:

Source	Target
user_id	user’s id

class aiocord.events.LeaveVoice(guild: Guild, user: GuildMember)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.leave.

guild: Source:

Source	Target
guild_id	id

user: Source:

Source	Target
user_id	user’s id

class aiocord.events.Speak(guild: Guild, user: GuildMember, flags: SpeechFlags, ssrc: int)

Bases: NamedTuple

Dispatched on enums.VoiceEvent.speak.

guild: Source:

Source	Target
guild_id	id

user: Source:

Source	Target
user_id	user’s id

flags: Source:

Source	Target
speaking

ssrc: Source:

Source	Target
ssrc

enums

class aiocord.enums.Intents(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Available Gateway Intents.

guilds = 1

guild_members = 2

guild_moderation = 4

guild_emojis_and_stickers = 8

guild_integrations = 16

guild_webhooks = 32

guild_invites = 64

guild_voice_states = 128

guild_presences = 256

guild_messages = 512

guild_message_reactions = 1024

guild_message_typing = 2048

direct_messages = 4096

direct_message_reactions = 8192

direct_message_typing = 16384

message_content = 32768

guild_scheduled_events = 65536

auto_moderation_configuration = 1048576

auto_moderation_action_execution = 2097152

classmethod default()

Get all the non-privilaged intents.

class aiocord.enums.GatewayEvent(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Available Events </topics/gateway-events#receive-events> received through gateway.enums.OpCode.dispatch.

ready = 'READY'

Source: Ready

update_application_command_permissions = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE'

Source: Application Command Permissions Update

create_auto_moderation_rule = 'AUTO_MODERATION_RULE_CREATE'

Source: Auto Moderation Rule Create

update_auto_moderation_rule = 'AUTO_MODERATION_RULE_UPDATE'

Source: Auto Moderation Rule Update

delete_auto_moderation_rule = 'AUTO_MODERATION_RULE_DELETE'

Source: Auto Moderation Rule Delete

execute_auto_moderation_action = 'AUTO_MODERATION_ACTION_EXECUTION'

Source: Auto Moderation Action Execution

create_channel = 'CHANNEL_CREATE'

Source: Channel Create

update_channel = 'CHANNEL_UPDATE'

Source: Channel Update

delete_channel = 'CHANNEL_DELETE'

Source: Channel Delete

update_channel_pins = 'CHANNEL_PINS_UPDATE'

Source: Channel Pins Update

create_thread = 'THREAD_CREATE'

Source: Thread Create

update_thread = 'THREAD_UPDATE'

Source: Thread Update

delete_thread = 'THREAD_DELETE'

Source: Thread Delete

sync_threads = 'THREAD_LIST_SYNC'

Source: Thread List Sync

update_thread_member = 'THREAD_MEMBER_UPDATE'

Source: Thread Member Update

update_thread_members = 'THREAD_MEMBERS_UPDATE'

Source: Thread Members Update

create_guild = 'GUILD_CREATE'

Source: Guild Create

update_guild = 'GUILD_UPDATE'

Source: Guild Update

delete_guild = 'GUILD_DELETE'

Source: Guild Delete

create_guild_audit_log_entry = 'GUILD_AUDIT_LOG_ENTRY_CREATE'

Source: Guild Audit Log Entry Create

create_guild_ban = 'GUILD_BAN_ADD'

Source: Guild Ban Add

delete_guild_ban = 'GUILD_BAN_REMOVE'

Source: Guild Ban Remove

update_guild_emojis = 'GUILD_EMOJIS_UPDATE'

Source: Guild Emojis Update

update_guild_stickers = 'GUILD_STICKERS_UPDATE'

Source: Guild Stickers Update

update_guild_integrations = 'GUILD_INTEGRATIONS_UPDATE'

Source: Guild Integrations Update

create_guild_member = 'GUILD_MEMBER_ADD'

Source: Guild Member Add

delete_guild_member = 'GUILD_MEMBER_REMOVE'

Source: Guild Member Remove

update_guild_member = 'GUILD_MEMBER_UPDATE'

Source: Guild Member Update

receive_guild_members = 'GUILD_MEMBERS_CHUNK'

Source: Guild Members Chunk

create_guild_role = 'GUILD_ROLE_CREATE'

Source: Guild Role Create

update_guild_role = 'GUILD_ROLE_UPDATE'

Source: Guild Role Update

delete_guild_role = 'GUILD_ROLE_DELETE'

Source: Guild Role Delete

create_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_CREATE'

Source: Guild Scheduled Event Create

update_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_UPDATE'

Source: Guild Scheduled Event Update

delete_guild_scheduled_event = 'GUILD_SCHEDULED_EVENT_DELETE'

Source: Guild Scheduled Event Delete

create_guild_scheduled_event_user = 'GUILD_SCHEDULED_EVENT_USER_ADD'

Source: Guild Scheduled Event User Add

delete_guild_scheduled_event_user = 'GUILD_SCHEDULED_EVENT_USER_REMOVE'

Source: Guild Scheduled Event User Remove

create_integration = 'INTEGRATION_CREATE'

Source: Integration Create

update_integration = 'INTEGRATION_UPDATE'

Source: Integration Update

delete_integration = 'INTEGRATION_DELETE'

Source: Integration Delete

create_interaction = 'INTERACTION_CREATE'

Source: Interaction Create

create_invite = 'INVITE_CREATE'

Source: Invite Create

delete_invite = 'INVITE_DELETE'

Source: Invite Delete

create_message = 'MESSAGE_CREATE'

Source: Message Create

update_message = 'MESSAGE_UPDATE'

Source: Message Update

delete_message = 'MESSAGE_DELETE'

Source: Message Delete

delete_messages = 'MESSAGE_DELETE_BULK'

Source: Message Delete Bulk

create_message_reaction = 'MESSAGE_REACTION_ADD'

Source: Message Reaction Add

delete_message_reaction = 'MESSAGE_REACTION_REMOVE'

Source: Message Reaction Remove

delete_all_message_reactions = 'MESSAGE_REACTION_REMOVE_ALL'

Source: Message Reaction Remove All

delete_all_message_emoji_reactions = 'MESSAGE_REACTION_REMOVE_EMOJI'

Source: Message Reaction Remove Emoji

update_presence = 'PRESENCE_UPDATE'

Source: Presence Update

create_stage_instance = 'STAGE_INSTANCE_CREATE'

Source: Stage Instance Create

update_stage_instance = 'STAGE_INSTANCE_UPDATE'

Source: Stage Instance Update

delete_stage_instance = 'STAGE_INSTANCE_DELETE'

Source: Stage Instance Delete

create_typing_indicator = 'TYPING_START'

Source: Typing Start

update_self_user = 'USER_UPDATE'

Source: User Update

update_voice_state = 'VOICE_STATE_UPDATE'

Source: Voice State Update

update_voice_server = 'VOICE_SERVER_UPDATE'

Source: Voice Server Update

update_webhooks = 'WEBHOOKS_UPDATE'

Source: Webhooks Update

create_entitlement = 'ENTITLEMENT_CREATE'

Source: https://discord.com/developers/docsEntitlement Create </monetization/entitlements#new-entitlement>

update_entitlement = 'ENTITLEMENT_UPDATE'

Source: https://discord.com/developers/docsEntitlement Update </monetization/entitlements#updated-entitlement>

delete_entitlement = 'ENTITLEMENT_DELETE'

Source: https://discord.com/developers/docsEntitlement Delete </monetization/entitlements#deleted-entitlement>

class aiocord.enums.VoiceEvent(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

speak = 'SPEAK'

A user has spoken.

enter = 'ENTER'

A user has joined the channel.

leave = 'LEAVE'

A user has left the channel.

utils

aiocord.utils.get_eventful_intents(Events)

Get the intents required to receive the specified events.

aiocord.utils.interact(client, callback, component, /, timeout=3)

Invoke a callback when the component has been interacted with.

If a .model.protocols.InteractionResponse is returned, it is used to respond via client.create_interaction_response().

Parameters:

• client (Source:) – The client to attach the callback to.

• callback (Source:) – Used with (event) if successful or (None) if timed-out.

• component (Source:) – A 'custom_id' will be set for identifying interactions to it.

• timeout (Source:) – Same as client.wait.timeout.

widget

class aiocord.widget.Info(client: Client, widgets: dict[str, module])

Bases: NamedTuple

Holds global information.

client: Source:

The client for which this widget has been loaded.

widgets: Source:

All currently loaded widgets.

aiocord.widget.callback(Event)

Create a callback for an core_event.

Parameters:

Event (Source:) – Any event dispatchable by client.Client.

Return type:

Source:

aiocord.widget.interact(*path)

Create a callback for an interaction.

If a .model.protocols.InteractionResponse is returned, it is used to respond via client.create_interaction_response().

Parameters:

*path – The command-name to sub[command/group]-name leading to the desired command.

Return type:

Source:

aiocord.widget.load(client, name, path=None, vendor=None, *, version=None)

Load a widget by creating and attaching events to the client.

Parameters:

• client (Source:) – The client to load the widget for.

• name (Source:) – The name of the widget, used for identifying in Info.widgets and drop()ing.

• path (Source:) – The location of the package. If not specified, the calling widget’s parent directory is used.

• vendor (Source:) – The vendor from which to download the widget, given that path is an the form of author/project/version.

• version (Source:) – The project version to fetch. The latest is used if not specified. Only valid when vendor is used.

Return type:

Source:

The widget may define a __load__(info) function, which will be called before callbacks are attached.

aiocord.widget.drop(client, name)

Unload a widget by detaching all the related callbles from the client.

Parameters:

• client (Source:) – The client to unload the widget for.

• name (Source:) – The name of the widget, as specified in load().

Return type:

Source:

The widget may define a __drop__ function which will be called after callbacks are detached.

vendor

Starting

Installing the library attaches a script to your terminal.

To use it, create an example blep/__init__.py file (relative imports are allowed).

Note

See aiocord.widget.load() and aiocord.widget.drop() for further details.

Then, simply run:

aiocord --token <TOKEN> start blep

Executing will create a client, connect to the gateway and begin listening to any events defined.

Updating

Defining interaction callbacks will do nothing unless you have created commands.

This can be achieved by creating a commands.json containing all desired commands.

Then, simply run:

aiocord --token <TOKEN> update commands

Executing will overwrite (delete/create/replace) the existing commands for the application.

Creating commands by hand can be cumbersome due to the complexity of the data required.

This can be eliviated using intellisense by creating a commands.py and defining a commands variable.

import aiocord

commands = [
    aiocord.model.protocols.ApplicationCommand(
        name = 'blep',
        type = aiocord.model.enums.ApplicationCommandType.chat_input,
        description = 'blep someone',
        options = [
            aiocord.model.protocols.ApplicationCommandOption(
                name = 'user',
                description = 'the user to blep',
                type = aiocord.model.enums.ApplicationCommandOptionType.user
            )
        ]
    )
]

Then, run the script as shown above.

The .py file will be used to generate the .json file before continuing.

Internal

The internal mechanisms of the library.

When scoped functionality is desired, these may be used directly.

http

The REST part of the Discord API.

client

class aiocord.http.client.Client(session, loads=<function loads>, dumps=<function dumps>, ignore_rate=False)

Bases: object

Core means of communication with the HTTP Discord API.

Parameters:

• session (Source:) – Used to make requests.

• loads (Source:) – Used for converting json text to objects.

• dumps (Source:) – Used for converting json objects to text.

• ignore_rate (Source:) – Whether to NOT handle rate limiting.

authenticate(token)

Return type:

Source:

Set the authentication token.

async request(verb, path, query=None, json=None, data=None, files=None, headers=None, identity=None)

Make a request to the API and get the responding data.

Parameters:

• verb (Source:) – The HTTP method.

• path (Source:) – The path portion for the url.

• query (Source:) – The HTTP query.

• json (Source:) – Used to compose the HTTP body.

• data (Source:) – Used to compose the HTTP body.

• headers (Source:) – The HTTP headers.

• identity (Source:) – Used for handling rate limits.

Return type:

Source:

routes

class aiocord.http.routes.Route(verb, path_template)

Bases: object

Contains all necessary data to perform a targeted request.

Parameters:

• verb (Source:) – The HTTP method.

• path_template (Source:) – The formattable path portion for the url.

route = Route('GET', '/path/{0}/to/{1}/resource')
value = await route(client, 'step0', 'step1', json = ..., params = ..., headers = ...)

aiocord.http.routes.get_global_application_commands = <Route(GET /applications/{0}/commands)>

Source: Get Global Application Commands

aiocord.http.routes.create_global_application_command = <Route(POST /applications/{0}/commands)>

Source: Create Global Application Command

aiocord.http.routes.get_global_application_command = <Route(GET /applications/{0}/commands/{1})>

Source: Get Global Application Command

aiocord.http.routes.update_global_application_command = <Route(PATCH /applications/{0}/commands/{1})>

Source: Edit Global Application Command

aiocord.http.routes.delete_global_application_command = <Route(DELETE /applications/{0}/commands/{1})>

Source: Delete Global Application Command

aiocord.http.routes.update_all_global_application_commands = <Route(PUT /applications/{0}/commands)>

Source: Bulk Overwrite Global Application Commands

aiocord.http.routes.get_guild_application_commands = <Route(GET /applications/{0}/guilds/{1}/commands)>

Source: Get Guild Application Commands

aiocord.http.routes.create_guild_application_command = <Route(POST /applications/{0}/guilds/{1}/commands)>

Source: Create Guild Application Command

aiocord.http.routes.get_guild_application_command = <Route(GET /applications/{0}/guilds/{1}/commands/{2})>

Source: Get Guild Application Command

aiocord.http.routes.update_guild_application_command = <Route(PATCH /applications/{0}/guilds/{1}/commands/{2})>

Source: Edit Guild Application Command

aiocord.http.routes.delete_guild_application_command = <Route(DELETE /applications/{0}/guilds/{1}/commands/{2})>

Source: Delete Guild Application Command

aiocord.http.routes.update_all_guild_application_commands = <Route(PUT /applications/{0}/guilds/{1}/commands)>

Source: Bulk Overwrite Guild Application Commands

aiocord.http.routes.get_guild_application_command_permissions = <Route(GET /applications/{0}/guilds/{1}/commands/permissions)>

Source: Get Guild Application Command Permissions

aiocord.http.routes.get_application_command_permissions = <Route(GET /applications/{0}/guilds/{1}/commands/{2}/permissions)>

Source: Get Application Command Permissions

aiocord.http.routes.update_application_command_permissions = <Route(PUT /applications/{0}/guilds/{1}/commands/{2}/permissions)>

Source: Edit Application Command Permissions

aiocord.http.routes.create_interaction_response = <Route(POST /interactions/{0}/{1}/callback)>

Source: Create Interaction Response

aiocord.http.routes.get_interaction_response = <Route(GET /webhooks/{0}/{1}/messages/@original)>

Source: Get Original Interaction Response

aiocord.http.routes.update_interaction_response = <Route(PATCH /webhooks/{0}/{1}/messages/@original)>

Source: Edit Original Interaction Response

aiocord.http.routes.delete_interaction_response = <Route(DELETE /webhooks/{0}/{1}/messages/@original)>

Source: Delete Original Interaction Response

aiocord.http.routes.create_followup_message = <Route(POST /webhooks/{0}/{1})>

Source: Create Followup Message

aiocord.http.routes.get_followup_message = <Route(GET /webhooks/{0}/{1}/messages/{2})>

Source: Get Followup Message

aiocord.http.routes.update_followup_message = <Route(PATCH /webhooks/{0}/{1}/messages/{2})>

Source: Edit Followup Message

aiocord.http.routes.delete_followup_message = <Route(DELETE /webhooks/{0}/{1}/messages/{2})>

Source: Delete Followup Message

aiocord.http.routes.get_application_role_connection_metadata = <Route(GET /applications/{0}/role-connections/metadata)>

Source: Get Application Role Connection Metadata Records

aiocord.http.routes.update_application_role_connection_metadata = <Route(PUT /applications/{0}/role-connections/metadata)>

Source: Update Application Role Connection Metadata Records

aiocord.http.routes.get_guild_audit_log = <Route(GET /guilds/{0}/audit-logs)>

Source: Get Guild Audit Log

aiocord.http.routes.get_guild_auto_moderation_rules = <Route(GET /guilds/{0}/auto-moderation/rules)>

Source: List Auto Moderation Rules For Guild

aiocord.http.routes.get_auto_moderation_rule = <Route(GET /guilds/{0}/auto-moderation/rules/{1})>

Source: Get Auto Moderation Rule

aiocord.http.routes.create_auto_moderation_rule = <Route(POST /guilds/{0}/auto-moderation/rules)>

Source: Create Auto Moderation Rule

aiocord.http.routes.update_auto_moderation_rule = <Route(PATCH /guilds/{0}/auto-moderation/rules/{1})>

Source: Modify Auto Moderation Rule

aiocord.http.routes.delete_auto_moderation_rule = <Route(DELETE /guilds/{0}/auto-moderation/rules/{1})>

Source: Delete Auto Moderation Rule

aiocord.http.routes.get_channel = <Route(GET /channels/{0})>

Source: Get Channel

aiocord.http.routes.update_channel = <Route(PATCH /channels/{0})>

Source: Modify Channel

aiocord.http.routes.delete_channel = <Route(DELETE /channels/{0})>

Source: Delete/Close Channel

aiocord.http.routes.get_messages = <Route(GET /channels/{0}/messages)>

Source: Get Channel Messages

aiocord.http.routes.get_message = <Route(GET /channels/{0}/messages/{1})>

Source: Get Channel Message

aiocord.http.routes.create_message = <Route(POST /channels/{0}/messages)>

Source: Create Message

aiocord.http.routes.create_message_crosspost = <Route(POST /channels/{0}/messages/{1}/crosspost)>

Source: Crosspost Message

aiocord.http.routes.create_reaction = <Route(PUT /channels/{0}/messages/{1}/reactions/{2}/@me)>

Source: Create Reaction

aiocord.http.routes.delete_own_reaction = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2}/@me)>

Source: Delete Own Reaction

aiocord.http.routes.delete_user_reaction = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2}/{3})>

Source: Delete User Reaction

aiocord.http.routes.get_reactions = <Route(GET /channels/{0}/messages/{1}/reactions/{2})>

Source: Get Reactions

aiocord.http.routes.delete_all_reactions = <Route(DELETE /channels/{0}/messages/{1}/reactions)>

Source: Delete All Reactions

aiocord.http.routes.delete_all_emoji_reactions = <Route(DELETE /channels/{0}/messages/{1}/reactions/{2})>

Source: Delete All Reactions For Emoji

aiocord.http.routes.update_message = <Route(PATCH /channels/{0}/messages/{1})>

Source: Edit Message

aiocord.http.routes.delete_message = <Route(DELETE /channels/{0}/messages/{1})>

Source: Delete Message

aiocord.http.routes.delete_messages = <Route(POST /channels/{0}/messages/bulk-delete)>

Source: Bulk Delete Messages

aiocord.http.routes.update_channel_permissions = <Route(PUT /channels/{0}/permissions/{1})>

Source: Edit Channel Permissions

aiocord.http.routes.get_channel_invites = <Route(GET /channels/{0}/invites)>

Source: Get Channel Invites

aiocord.http.routes.create_channel_invite = <Route(POST /channels/{0}/invites)>

Source: Create Channel Invite

aiocord.http.routes.delete_channel_permission = <Route(DELETE /channels/{0}/permissions/{1})>

Source: Delete Channel Permission

aiocord.http.routes.create_channel_follow = <Route(POST /channels/{0}/followers)>

Source: Follow Announcement Channel

aiocord.http.routes.create_typing_indicator = <Route(POST /channels/{0}/typing)>

Source: Trigger Typing Indicator

aiocord.http.routes.get_channel_pins = <Route(GET /channels/{0}/pins)>

Source: Get Pinned Messages

aiocord.http.routes.create_channel_pin = <Route(PUT /channels/{0}/pins/{1})>

Source: Pin Message

aiocord.http.routes.delete_channel_pin = <Route(DELETE /channels/{0}/pins/{1})>

Source: Unpin Message

aiocord.http.routes.create_channel_recipient = <Route(PUT /channels/{0}/recipients/{1})>

Source: Group Dm Add Recipient

aiocord.http.routes.delete_channel_recipient = <Route(DELETE /channels/{0}/recipients/{1})>

Source: Group Dm Remove Recipient

aiocord.http.routes.create_message_thread = <Route(POST /channels/{0}/messages/{1}/threads)>

Source: Start Thread From Message

aiocord.http.routes.create_thread = <Route(POST /channels/{0}/threads)>

Source: Start Thread Without Message

aiocord.http.routes.create_self_thread_member = <Route(PUT /channels/{0}/thread-members/@me)>

Source: Join Thread

aiocord.http.routes.create_thread_member = <Route(PUT /channels/{0}/thread-members/{1})>

Source: Add Thread Member

aiocord.http.routes.delete_self_thread_member = <Route(DELETE /channels/{0}/thread-members/@me)>

Source: Leave Thread

aiocord.http.routes.delete_thread_member = <Route(DELETE /channels/{0}/thread-members/{1})>

Source: Remove Thread Member

aiocord.http.routes.get_thread_member = <Route(GET /channels/{0}/thread-members/{1})>

Source: Get Thread Member

aiocord.http.routes.get_thread_members = <Route(GET /channels/{0}/thread-members)>

Source: List Thread Members

aiocord.http.routes.get_public_archived_threads = <Route(GET /channels/{0}/threads/archived/public)>

Source: List Public Archived Threads

aiocord.http.routes.get_private_archived_threads = <Route(GET /channels/{0}/threads/archived/private)>

Source: List Private Archived Threads

aiocord.http.routes.get_self_private_archived_threads = <Route(GET /channels/{0}/users/@me/threads/archived/private)>

Source: List Joined Private Archived Threads

aiocord.http.routes.get_guild_emojis = <Route(GET /guilds/{0}/emojis)>

Source: List Guild Emojis

aiocord.http.routes.get_guild_emoji = <Route(GET /guilds/{0}/emojis/{1})>

Source: Get Guild Emoji

aiocord.http.routes.create_guild_emoji = <Route(POST /guilds/{0}/emojis)>

Source: Create Guild Emoji

aiocord.http.routes.update_guild_emoji = <Route(PATCH /guilds/{0}/emojis/{1})>

Source: Modify Guild Emoji

aiocord.http.routes.delete_guild_emoji = <Route(DELETE /guilds/{0}/emojis/{1})>

Source: Delete Guild Emoji

aiocord.http.routes.create_guild = <Route(POST /guilds)>

Source: Create Guild

aiocord.http.routes.get_guild = <Route(GET /guilds/{0})>

Source: Get Guild

aiocord.http.routes.get_guild_preview = <Route(GET /guilds/{0}/preview)>

Source: Get Guild Preview

aiocord.http.routes.update_guild = <Route(PATCH /guilds/{0})>

Source: Modify Guild

aiocord.http.routes.delete_guild = <Route(DELETE /guilds/{0})>

Source: Delete Guild

aiocord.http.routes.get_guild_channels = <Route(GET /guilds/{0}/channels)>

Source: Get Guild Channels

aiocord.http.routes.create_guild_channel = <Route(POST /guilds/{0}/channels)>

Source: Create Guild Channel

aiocord.http.routes.update_guild_channel_positions = <Route(PATCH /guilds/{0}/channels)>

Source: Modify Guild Channel Positions

aiocord.http.routes.get_active_guild_threads = <Route(GET /guilds/{0}/threads/active)>

Source: List Active Guild Threads

aiocord.http.routes.get_guild_member = <Route(GET /guilds/{0}/members/{1})>

Source: Get Guild Member

aiocord.http.routes.get_guild_members = <Route(GET /guilds/{0}/members)>

Source: List Guild Members

aiocord.http.routes.search_guild_members = <Route(GET /guilds/{0}/members/search)>

Source: Search Guild Members

aiocord.http.routes.create_guild_member = <Route(PUT /guilds/{0}/members/{1})>

Source: Add Guild Member

aiocord.http.routes.update_guild_member = <Route(PATCH /guilds/{0}/members/{1})>

Source: Modify Guild Member

aiocord.http.routes.update_self_guild_member = <Route(PATCH /guilds/{0}/members/@me)>

Source: Modify Current Member

aiocord.http.routes.create_guild_member_role = <Route(PUT /guilds/{0}/members/{1}/roles/{2})>

Source: Add Guild Member Role

aiocord.http.routes.delete_guild_member_role = <Route(DELETE /guilds/{0}/members/{1}/roles/{2})>

Source: Remove Guild Member Role

aiocord.http.routes.delete_guild_member = <Route(DELETE /guilds/{0}/members/{1})>

Source: Remove Guild Member

aiocord.http.routes.get_guild_bans = <Route(GET /guilds/{0}/bans)>

Source: Get Guild Bans

aiocord.http.routes.get_guild_ban = <Route(GET /guilds/{0}/bans/{1})>

Source: Get Guild Ban

aiocord.http.routes.create_guild_ban = <Route(PUT /guilds/{0}/bans/{1})>

Source: Create Guild Ban

aiocord.http.routes.delete_guild_ban = <Route(DELETE /guilds/{0}/bans/{1})>

Source: Remove Guild Ban

aiocord.http.routes.get_guild_roles = <Route(GET /guilds/{0}/roles)>

Source: Get Guild Roles

aiocord.http.routes.create_guild_role = <Route(POST /guilds/{0}/roles)>

Source: Create Guild Role

aiocord.http.routes.update_guild_role_positions = <Route(PATCH /guilds/{0}/roles)>

Source: Modify Guild Role Positions

aiocord.http.routes.update_guild_role = <Route(PATCH /guilds/{0}/roles/{1})>

Source: Modify Guild Role

aiocord.http.routes.update_guild_mfa_level = <Route(POST /guilds/{0}/mfa)>

Source: Modify Guild Mfa Level

aiocord.http.routes.delete_guild_role = <Route(DELETE /guilds/{0}/roles/{1})>

Source: Delete Guild Role

aiocord.http.routes.get_guild_prune_count = <Route(GET /guilds/{0}/prune)>

Source: Get Guild Prune Count

aiocord.http.routes.start_guild_prune = <Route(POST /guilds/{0}/prune)>

Source: Begin Guild Prune

aiocord.http.routes.get_guild_voice_regions = <Route(GET /guilds/{0}/regions)>

Source: Get Guild Voice Regions

aiocord.http.routes.get_guild_invites = <Route(GET /guilds/{0}/invites)>

Source: Get Guild Invites

aiocord.http.routes.get_guild_integrations = <Route(GET /guilds/{0}/integrations)>

Source: Get Guild Integrations

aiocord.http.routes.delete_guild_integration = <Route(DELETE /guilds/{0}/integrations/{1})>

Source: Delete Guild Integration

aiocord.http.routes.get_guild_widget_settings = <Route(GET /guilds/{0}/widget)>

Source: Get Guild Widget Settings

aiocord.http.routes.update_guild_widget = <Route(PATCH /guilds/{0}/widget)>

Source: Modify Guild Widget

aiocord.http.routes.get_guild_widget = <Route(GET /guilds/{0}/widget.json)>

Source: Get Guild Widget

aiocord.http.routes.get_guild_vanity_url = <Route(GET /guilds/{0}/vanity-url)>

Source: Get Guild Vanity Url

aiocord.http.routes.get_guild_widget_image = <Route(GET /guilds/{0}/widget.png)>

Source: Get Guild Widget Image

aiocord.http.routes.get_guild_welcome_screen = <Route(GET /guilds/{0}/welcome-screen)>

Source: Get Guild Welcome Screen

aiocord.http.routes.update_guild_welcome_screen = <Route(PATCH /guilds/{0}/welcome-screen)>

Source: Modify Guild Welcome Screen

aiocord.http.routes.get_guild_onboarding = <Route(GET /guilds/{0}/onboarding)>

Source: Get Guild Onboarding

aiocord.http.routes.update_self_voice_state = <Route(PATCH /guilds/{0}/voice-states/@me)>

Source: Modify Current User Voice State

aiocord.http.routes.update_voice_state = <Route(PATCH /guilds/{0}/voice-states/{1})>

Source: Modify User Voice State

aiocord.http.routes.get_guild_scheduled_events = <Route(GET /guilds/{0}/scheduled-events)>

Source: List Scheduled Events For Guild

aiocord.http.routes.create_guild_scheduled_event = <Route(POST /guilds/{0}/scheduled-events)>

Source: Create Guild Scheduled Event

aiocord.http.routes.get_guild_scheduled_event = <Route(GET /guilds/{0}/scheduled-events/{1})>

Source: Get Guild Scheduled Event

aiocord.http.routes.update_guild_scheduled_event = <Route(PATCH /guilds/{0}/scheduled-events/{1})>

Source: Modify Guild Scheduled Event

aiocord.http.routes.delete_guild_scheduled_event = <Route(DELETE /guilds/{0}/scheduled-events/{1})>

Source: Delete Guild Scheduled Event

aiocord.http.routes.get_guild_scheduled_event_users = <Route(GET /guilds/{0}/scheduled-events/{1}/users)>

Source: Get Guild Scheduled Event Users

aiocord.http.routes.get_guild_template = <Route(GET /guilds/templates/{0})>

Source: Get Guild Template

aiocord.http.routes.create_guild_via_guild_template = <Route(POST /guilds/templates/{0})>

Source: Create Guild From Guild Template

aiocord.http.routes.get_guild_templates = <Route(GET /guilds/{0}/templates)>

Source: Get Guild Templates

aiocord.http.routes.create_guild_template = <Route(POST /guilds/{0}/templates)>

Source: Create Guild Template

aiocord.http.routes.sync_guild_template = <Route(PUT /guilds/{0}/templates/{1})>

Source: Sync Guild Template

aiocord.http.routes.update_guild_template = <Route(PATCH /guilds/{0}/templates/{1})>

Source: Modify Guild Template

aiocord.http.routes.delete_guild_template = <Route(DELETE /guilds/{0}/templates/{1})>

Source: Delete Guild Template

aiocord.http.routes.get_invite = <Route(GET /invites/{0})>

Source: Get Invite

aiocord.http.routes.delete_invite = <Route(DELETE /invites/{0})>

Source: Delete Invite

aiocord.http.routes.create_stage_instance = <Route(POST /stage-instances)>

Source: Create Stage Instance

aiocord.http.routes.get_stage_instance = <Route(GET /stage-instances/{0})>

Source: Get Stage Instance

aiocord.http.routes.update_stage_instance = <Route(PATCH /stage-instances/{0})>

Source: Modify Stage Instance

aiocord.http.routes.delete_stage_instance = <Route(DELETE /stage-instances/{0})>

Source: Delete Stage Instance

aiocord.http.routes.get_sticker = <Route(GET /stickers/{0})>

Source: Get Sticker

aiocord.http.routes.get_sticker_packs = <Route(GET /sticker-packs)>

Source: List Nitro Sticker Packs

aiocord.http.routes.get_guild_stickers = <Route(GET /guilds/{0}/stickers)>

Source: List Guild Stickers

aiocord.http.routes.get_guild_sticker = <Route(GET /guilds/{0}/stickers/{1})>

Source: Get Guild Sticker

aiocord.http.routes.create_guild_sticker = <Route(POST /guilds/{0}/stickers)>

Source: Create Guild Sticker

aiocord.http.routes.update_guild_sticker = <Route(PATCH /guilds/{0}/stickers/{1})>

Source: Modify Guild Sticker

aiocord.http.routes.delete_guild_sticker = <Route(DELETE /guilds/{0}/stickers/{1})>

Source: Delete Guild Sticker

aiocord.http.routes.get_self_user = <Route(GET /users/@me)>

Source: Get Current User

aiocord.http.routes.get_user = <Route(GET /users/{0})>

Source: Get User

aiocord.http.routes.update_self_user = <Route(PATCH /users/@me)>

Source: Modify Current User

aiocord.http.routes.get_self_guilds = <Route(GET /users/@me/guilds)>

Source: Get Current User Guilds

aiocord.http.routes.get_self_guild_member = <Route(GET /users/@me/guilds/{0}/member)>

Source: Get Current User Guild Member

aiocord.http.routes.delete_self_guild_member = <Route(DELETE /users/@me/guilds/{0})>

Source: Leave Guild

aiocord.http.routes.create_self_channel = <Route(POST /users/@me/channels)>

Source: Create Dm

aiocord.http.routes.get_self_connections = <Route(GET /users/@me/connections)>

Source: Get User Connections

aiocord.http.routes.get_self_application_role_connection = <Route(GET /users/@me/applications/{0}/role-connection)>

Source: Get User Application Role Connection

aiocord.http.routes.update_self_application_role_connection = <Route(PUT /users/@me/applications/{0}/role-connection)>

Source: Update User Application Role Connection

aiocord.http.routes.get_voice_regions = <Route(GET /voice/regions)>

Source: List Voice Regions

aiocord.http.routes.create_webhook = <Route(POST /channels/{0}/webhooks)>

Source: Create Webhook

aiocord.http.routes.get_channel_webhooks = <Route(GET /channels/{0}/webhooks)>

Source: Get Channel Webhooks

aiocord.http.routes.get_guild_webhooks = <Route(GET /guilds/{0}/webhooks)>

Source: Get Guild Webhooks

aiocord.http.routes.get_webhook = <Route(GET /webhooks/{0})>

Source: Get Webhook

aiocord.http.routes.get_webhook_via_token = <Route(GET /webhooks/{0}/{1})>

Source: Get Webhook With Token

aiocord.http.routes.update_webhook = <Route(PATCH /webhooks/{0})>

Source: Modify Webhook

aiocord.http.routes.update_webhook_via_token = <Route(PATCH /webhooks/{0}/{1})>

Source: Modify Webhook With Token

aiocord.http.routes.delete_webhook = <Route(DELETE /webhooks/{0})>

Source: Delete Webhook

aiocord.http.routes.delete_webhook_via_token = <Route(DELETE /webhooks/{0}/{1})>

Source: Delete Webhook With Token

aiocord.http.routes.create_webhook_message = <Route(POST /webhooks/{0}/{1})>

Source: Execute Webhook

aiocord.http.routes.create_webhook_message_slack_compatible = <Route(POST /webhooks/{0}/{1}/slack)>

Source: Execute Slack Compatible Webhook

aiocord.http.routes.create_webhook_message_github_compatible = <Route(POST /webhooks/{0}/{1}/github)>

Source: Execute Github Compatible Webhook

aiocord.http.routes.get_webhook_message = <Route(GET /webhooks/{0}/{1}/messages/{2})>

Source: Get Webhook Message

aiocord.http.routes.update_webhook_message = <Route(PATCH /webhooks/{0}/{1}/messages/{2})>

Source: Edit Webhook Message

aiocord.http.routes.delete_webhook_message = <Route(DELETE /webhooks/{0}/{1}/messages/{2})>

Source: Delete Webhook Message

aiocord.http.routes.get_gateway = <Route(GET /gateway)>

Source: Get Gateway

aiocord.http.routes.get_gateway_bot = <Route(GET /gateway/bot)>

Source: Get Gateway Bot

aiocord.http.routes.get_self_application_information = <Route(GET /oauth2/applications/@me)>

Source: Get Current Bot Application Information

aiocord.http.routes.get_self_authorization_information = <Route(GET /oauth2/@me)>

Source: Get Current Authorization Information

aiocord.http.routes.get_skus = <Route(GET /applications/{0}/skus)>

Source: List SKUs

aiocord.http.routes.get_entitlements = <Route(GET /applications/{0}/entitlements)>

Source: List Entitlements

aiocord.http.routes.create_entitlement = <Route(POST /applications/{0}/entitlements)>

Source: Create Test Entitlement

aiocord.http.routes.delete_entitlement = <Route(DELETE /applications/{0}/entitlements/{1})>

Source: Delete Test Entitlement

errors

exception aiocord.http.errors.Base

Bases: Exception

Base module error.

exception aiocord.http.errors.Client

Bases: Base

Base for client errors.

exception aiocord.http.errors.Interrupted

Bases: Client

A request was interrupted.

exception aiocord.http.errors.Request(response, data)

Bases: Client

Received a response with an unsupported status.

property response

property data

exception aiocord.http.errors.Internal(response, data)

Bases: Request

There was an server error.

exception aiocord.http.errors.BadRequest(response, data)

Bases: Request

The request was badly formatted.

exception aiocord.http.errors.Unauthorized(response, data)

Bases: Request

The request token is missing or invalid.

exception aiocord.http.errors.Forbidden(response, data)

Bases: Request

The user is missing the necessary permissions for the request.

exception aiocord.http.errors.NotFound(response, data)

Bases: Request

The target resource could not be found.

exception aiocord.http.errors.RateLimited(response, data)

Bases: Request

There are too many requests being sent.

gateway

The Gateway part of the Discord API.

client

class aiocord.gateway.client.Client(callback, session, token, intents, uri, info_id, info_count, encoding='json', present=None, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of communication with the Discord Gateway API.

Parameters:

• callback (Source:) – Used for dispatching events.

• session (Source:) – Used for creating websocket connections.

• token (Source:) – Used for authentication during identify and resume.

• intents (Source:) – Used for signaling which events to allow through during identify.

• uri (Source:) – Used for creating werbsocket connections. Must be fetched from Get Gateway:ddoc: Bot </topics/gateway#get-gateway-bot>.

• info_id (Source:) – The id of the shard.

• info_count (Source:) – The total amount of shards.

• encoding (Source:) – The desired encoding. Can be 'json' or 'etf', and by chosing either, loads and dumps should be adjusted accordingly.

• present (Source:) – Used for fetching the initial presence to send during identify.

• loads (Source:) – Used for converting json text to objects.

• dumps (Source:) – Used for converting json objects to text.

property info

property event_identify

property event_complete

inform_session(session_id, resume_uri)

Update the session information.

Parameters:

• session_id (Source:) – The session id. Can be found as 'session_id' in the ready event.

• resume_uri (Source:) – Used for resuming the session. Can be found as 'resume_gateway_url' in the ready event.

async request_guild_members(data)

Source: Request Guild Members

update_voice_state(data)

Return type:

Source:

Source: Update Voice State

update_presence(status, activities, since, afk)

Return type:

Source:

Source: Update Presence

start()

Return type:

Source:

Start the connection lifecycle.

stop()

Return type:

Source:

Cancel tasks and close connections.

errors

exception aiocord.gateway.errors.Base

Bases: Exception

Base module error.

exception aiocord.gateway.errors.Client

Bases: Base

Base for client errors.

exception aiocord.gateway.errors.Interrupted

Bases: Connection

Received a non-salvageable close code.

exception aiocord.gateway.errors.Invalidated

Bases: Connection

Received a non-salvageable invalid session.

voice

The Voice part of the Discord API.

client

class aiocord.voice.client.Client(callback, session, user_id, guild_id, session_id, token, uri, loads=<function loads>, dumps=<function dumps>)

Bases: object

Core means of communication with the Discord Voice API.

Parameters:

• callback (Source:) – Used for dispatching events.

• session (Source:) – Used for creating websocket connections.

• user_id (Source:) – The connecting client’s user id.

• guild_id (Source:) – The connecting guild’s id.

• session_id (Source:) – The voice state session id.

• token (Source:) – The voice server token.

• uri (Source:) – The voice server endpoint.

• loads (Source:) – Used for converting json text to objects.

• dumps (Source:) – Used for converting json objects to text.

property guild_id: str

The connected guild’s id.

property event_identify: Event

Set after the identify payload has been sent.

property event_complete: Event

Set after the session description has been handled or when resumed.

property codec: str

The name of the expected codec.

property player: Player

The player.

send_audio(samples, data)

Send an audio packet.

Parameters:

• samples (Source:) – The sample count per frame.

• data (Source:) – The encoded packet data.

Return type:

Source:

start()

Return type:

Source:

Start the connection lifecycle.

stop()

Return type:

Source:

Cancel tasks and close connections.

audio

class aiocord.voice.audio.Audio(source='-', executable='ffmpeg', codec='opus', sample_rate=48000, channels=2, bit_depth=16, frame_duration=0.02)

Bases: object

Manages a FFMPEG subprocess for converting and encoding audio.

:param Source:

The source of the file, or '-' if data is going to be fed later.

Parameters:

executable (Source:) – The path to the FFMPEG executable.

All other parameters should remain as-is according to discord’s specification.

property sample_rate

property channels

property frame_duration

property sample_bytes_count

property frame_samples_count

property frame_bytes_count

property join

feed(data)

Feed data if '-' has been used for the source.

Parameters:

data (Source:) – The data to write to the subprocess.

Return type:

Source:

get()

Return type:

Source:

Get a single audio packet.

start()

Return type:

Source:

Create the subprocess for feeding and reading data.

stop()

Return type:

Source:

Stop the reading data and close the subprocess.

player

class aiocord.voice.player.Player(send)

Bases: object

Manages timely sending voice packets.

Parameters:

send (Source:) – Used with (samples, data) for sending.

property audio: Audio

The current audio source.

start(audio)

Start sending voice packets.

Parameters:

audio (Source:) – Used for reading.

Note

Will close() the source when all packets have been sent.

Return type:

Source:

stop()

Return type:

Source:

Close the current audio source.

errors

exception aiocord.voice.errors.Base

Bases: Exception

Base module error.

exception aiocord.voice.errors.Client

Bases: Base

Base for client errors.

exception aiocord.voice.errors.Connection

Bases: Client

Base for connection-related errors.

exception aiocord.voice.errors.Interrupted

Bases: Connection

Received a non-salvageable close code.

exception aiocord.voice.errors.Transmission

Bases: Client

Base for creating and sending audio errors.

exception aiocord.voice.errors.SocketClosed

Bases: Transmission

The socket is closed upon sending audio.

exception aiocord.voice.errors.Player

Bases: Base

Base for player.Player errors.

exception aiocord.voice.errors.Audio

Bases: Player

Base for audio.Audio errors.

exception aiocord.voice.errors.Stream

Bases: Audio

Base for stream.Stream errors.

exception aiocord.voice.errors.StreamPrefixMissing

Bases: Stream

Got an unexpected audio stream OGG prefix.

exception aiocord.voice.errors.StreamComplete

Bases: Stream

The audio OGG stream has been exhausted.

model

All forms of data that may be encountered while interacting Discord API.

types

All types found within more complex objects.

aiocord.model.types.String

alias of str

aiocord.model.types.Boolean

alias of bool

aiocord.model.types.Integer

alias of int

aiocord.model.types.Decimal

alias of float

aiocord.model.types.List

alias of list

aiocord.model.types.Dict

alias of dict

class aiocord.model.types.Timestamp

Bases: int

A Unix Timestamp.

property datetime: datetime

The datetime object representation.

mention(style=None)

Get the mention.

Parameters:

style (Source:) – The visual representation type.

class aiocord.model.types.ISO8601Timestamp

Bases: str

Source: ISO8601 Date/Time

property datetime: datetime

The datetime object representation.

class aiocord.model.types.Snowflake

Bases: str

Source: Snowflakes

property timestamp: Timestamp

The internal timestamp.

enums

All enumerations found within more complex objects.

class aiocord.model.enums.ApplicationCommandType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Command Option Types

chat_input = 1

user = 2

message = 3

class aiocord.model.enums.StatusType(data, *args, **kwargs)

Bases: StrEnum

Source: Update Presence Status Types

online = 'online'

dnd = 'dnd'

idle = 'idle'

invisible = 'invisible'

offline = 'offline'

class aiocord.model.enums.Locale(data, *args, **kwargs)

Bases: StrEnum

Source: Locales

indonesian = 'id'

danish = 'da'

german = 'de'

english_uk = 'en-GB'

english_us = 'en-US'

spanish_es = 'es-ES'

french = 'fr'

croatian = 'hr'

italian = 'it'

lithuanian = 'lt'

hungarian = 'hu'

dutch = 'nl'

norwegian = 'no'

polish = 'pl'

portuguese_br = 'pt-BR'

romanian = 'ro'

finnish = 'fi'

swedish_se = 'sv-SE'

vietnamese = 'vi'

turkish = 'tr'

czech = 'cs'

greek = 'el'

bulgarian = 'bg'

russian = 'ru'

ukrainian = 'uk'

hindi = 'hi'

thai = 'th'

chinese_cn = 'zh-CN'

japanese = 'ja'

chinese_tw = 'zh-TW'

korean = 'ko'

class aiocord.model.enums.Permissions(data, *args, **kwargs)

Bases: IntFlag

Source: Permission Flags

create_instant_invite = 1

kick_members = 2

ban_members = 4

administrator = 8

manage_channels = 16

manage_guild = 32

add_reactions = 64

view_audit_log = 128

priority_speaker = 256

stream = 512

view_channel = 1024

send_messages = 2048

send_tts_messages = 4096

manage_messages = 8192

embed_links = 16384

attach_files = 32768

read_message_history = 65536

mention_everyone = 131072

use_external_emojis = 262144

view_guild_insights = 524288

connect = 1048576

speak = 2097152

mute_members = 4194304

deafen_members = 8388608

move_members = 16777216

use_vad = 33554432

change_nickname = 67108864

manage_nicknames = 134217728

manage_roles = 268435456

manage_webhooks = 536870912

manage_guild_expressions = 1073741824

use_application_commands = 2147483648

request_to_speak = 4294967296

manage_events = 8589934592

manage_threads = 17179869184

create_public_threads = 34359738368

create_private_threads = 68719476736

use_external_stickers = 137438953472

send_messages_in_threads = 274877906944

use_embedded_activities = 549755813888

moderate_members = 1099511627776

view_creator_monetization_analytics = 2199023255552

use_soundboard = 4398046511104

create_guild_expressions = 8796093022208

create_events = 17592186044416

send_voice_messages = 70368744177664

class aiocord.model.enums.ApplicationCommandOptionType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Command Option Types

sub_command = 1

sub_command_group = 2

string = 3

integer = 4

boolean = 5

user = 6

channel = 7

role = 8

mentionable = 9

number = 10

attachment = 11

class aiocord.model.enums.ChannelType(data, *args, **kwargs)

Bases: IntEnum

Source: Channel Types

guild_text = 0

dm = 1

guild_voice = 2

group_dm = 3

guild_category = 4

guild_announcement = 5

announcement_thread = 10

public_thread = 11

private_thread = 12

guild_stage_voice = 13

guild_directory = 14

guild_forum = 15

guild_media = 16

class aiocord.model.enums.MessageComponentType(data, *args, **kwargs)

Bases: IntEnum

Source: Component Types

action_row = 1

button = 2

string_select = 3

text_input = 4

user_select = 5

role_select = 6

mentionable_select = 7

channel_select = 8

class aiocord.model.enums.MessageButtonComponentStyle(data, *args, **kwargs)

Bases: IntEnum

Source: Button Styles

primary = 1

secondary = 2

success = 3

danger = 4

link = 5

class aiocord.model.enums.MessageTextInputComponentStyle(data, *args, **kwargs)

Bases: IntEnum

Source: Text Input Styles

short = 1

paragraph = 2

class aiocord.model.enums.InteractionType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Types

ping = 1

application_command = 2

message_component = 3

application_command_autocomplete = 4

modal_submit = 5

class aiocord.model.enums.InteractionContextType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Context Types

guild = 0

bot_dm = 1

private_channel = 2

class aiocord.model.enums.InteractionResponseType(data, *args, **kwargs)

Bases: IntEnum

Source: Interaction Callback Types

pong = 1

channel_message_with_source = 4

deferred_channel_message_with_source = 5

deferred_update_message = 6

update_message = 7

application_command_autocomplete_result = 8

modal = 9

premium_required = 10

class aiocord.model.enums.ApplicationIntegrationType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Integration Types

guild_install = 0

user_install = 1

class aiocord.model.enums.ApplicationFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Application Flags

application_auto_moderation_rule_create_badge = 64

gateway_presence = 4096

gateway_presence_limited = 8192

gateway_guild_members = 16384

gateway_guild_members_limited = 32768

verification_pending_guild_limit = 65536

embedded = 131072

gateway_message_content = 262144

gateway_message_content_limited = 524288

application_command_badge = 8388608

class aiocord.model.enums.ApplicationRoleConnectionMetadataType(data, *args, **kwargs)

Bases: IntEnum

Source: Application Role Connection Metadata Types

integer_less_than_or_equal = 1

integer_greater_than_or_equal = 2

integer_equal = 3

integer_not_equal = 4

datetime_less_than_or_equal = 5

datetime_greater_than_or_equal = 6

boolean_equal = 7

boolean_not_equal = 8

class aiocord.model.enums.AuditLogEvent(data, *args, **kwargs)

Bases: IntEnum

Source: Audit Log Events

guild_update = 1

channel_create = 10

channel_update = 11

channel_delete = 12

channel_overwrite_create = 13

channel_overwrite_update = 14

channel_overwrite_delete = 15

member_kick = 20

member_prune = 21

member_ban_add = 22

member_ban_remove = 23

member_update = 24

member_role_update = 25

member_move = 26

member_disconnect = 27

bot_add = 28

role_create = 30

role_update = 31

role_delete = 32

invite_create = 40

invite_update = 41

invite_delete = 42

webhook_create = 50

webhook_update = 51

webhook_delete = 52

emoji_create = 60

emoji_update = 61

emoji_delete = 62

message_delete = 72

message_bulk_delete = 73

message_pin = 74

message_unpin = 75

integration_create = 80

integration_update = 81

integration_delete = 82

stage_instance_create = 83

stage_instance_update = 84

stage_instance_delete = 85

sticker_create = 90

sticker_update = 91

sticker_delete = 92

guild_scheduled_event_create = 100

guild_scheduled_event_update = 101

guild_scheduled_event_delete = 102

thread_create = 110

thread_update = 111

thread_delete = 112

application_command_permission_update = 121

auto_moderation_rule_create = 140

auto_moderation_rule_update = 141

auto_moderation_rule_delete = 142

auto_moderation_block_message = 143

auto_moderation_flag_to_channel = 144

auto_moderation_user_communication_disabled = 145

class aiocord.model.enums.OptionalAuditLogEntryInfoOverwrittenEntityType(data, *args, **kwargs)

Bases: StrEnum

Source: Optional Audit Entry Info

role = '0'

member = '1'

class aiocord.model.enums.AutoModerationTriggerType(data, *args, **kwargs)

Bases: IntEnum

Source: Trigger Types

keyword = 1

spam = 3

keyword_preset = 4

mention_spam = 5

class aiocord.model.enums.AutoModerationRuleKeywordPresetType(data, *args, **kwargs)

Bases: IntEnum

Source: Keyword Preset Types

profanity = 1

sexual_content = 2

slurs = 3

class aiocord.model.enums.AutoModerationRuleEventType(data, *args, **kwargs)

Bases: IntEnum

Source: Event Types

message_send = 1

class aiocord.model.enums.AutoModerationActionType(data, *args, **kwargs)

Bases: IntEnum

Source: Action Types

block_message = 1

send_alert_message = 2

timeout = 3

class aiocord.model.enums.ChannelVideoQualityMode(data, *args, **kwargs)

Bases: IntEnum

Source: Video Quality Modes

auto = 1

full = 2

class aiocord.model.enums.ChannelFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Channel Flags

pinned = 2

require_tag = 16

class aiocord.model.enums.ChannelSortOrderType(data, *args, **kwargs)

Bases: IntEnum

Source: Sort Order Types

latest_activity = 0

creation_date = 1

class aiocord.model.enums.ForumLayoutType(data, *args, **kwargs)

Bases: IntEnum

Source: Forum Layout Types

not_set = 0

list_view = 1

gallery_view = 2

class aiocord.model.enums.MessageType(data, *args, **kwargs)

Bases: IntEnum

Source: Message Types

default = 0

recipient_add = 1

recipient_remove = 2

call = 3

channel_name_change = 4

channel_icon_change = 5

channel_pinned_message = 6

user_join = 7

guild_boost = 8

guild_boost_tier_1 = 9

guild_boost_tier_2 = 10

guild_boost_tier_3 = 11

channel_follow_add = 12

guild_discovery_disqualified = 14

guild_discovery_requalified = 15

guild_discovery_grace_period_initial_warning = 16

guild_discovery_grace_period_final_warning = 17

thread_created = 18

reply = 19

chat_input_command = 20

thread_starter_message = 21

guild_invite_reminder = 22

context_menu_command = 23

auto_moderation_action = 24

role_subscription_purchase = 25

interaction_premium_upsell = 26

stage_start = 27

stage_end = 28

stage_speaker = 29

stage_topic = 31

guild_application_premium_subscription = 32

class aiocord.model.enums.MessageActivityType(data, *args, **kwargs)

Bases: IntEnum

Source: Message Activity Types

join = 1

spectate = 2

listen = 3

join_request = 5

class aiocord.model.enums.MessageFlags(data, *args, **kwargs)

Bases: IntEnum

Source: Message Flags

crossposted = 1

is_crosspost = 2

suppress_embeds = 4

source_message_deleted = 8

urgent = 16

has_thread = 32

ephemeral = 64

loading = 128

failed_to_mention_some_roles_in_thread = 256

suppress_notifications = 4096

is_voice_message = 8192

class aiocord.model.enums.OverwriteType(data, *args, **kwargs)

Bases: IntEnum

Source: Overwrite Structure

role = 0

member = 1

class aiocord.model.enums.EmbedType(data, *args, **kwargs)

Bases: StrEnum

Source: Embed Types

rich = 'rich'

image = 'image'

video = 'video'

gifv = 'gifv'

article = 'article'

link = 'link'

class aiocord.model.enums.AllowedMentionsType(data, *args, **kwargs)

Bases: StrEnum

Source: Allowed Mention Types

roles = 'roles'

users = 'users'

everyone = 'everyone'

class aiocord.model.enums.GuildVerificationLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Verification Level

none = 0

low = 1

medium = 2

high = 3

very_high = 4

class aiocord.model.enums.GuildDefaultMessageNotificationLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Default Message Notification Level

all_messages = 0

only_mentions = 1

class aiocord.model.enums.GuildExplicitContentFilterLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Explicit Content Filter Level

disabled = 0

members_without_roles = 1

all_members = 2

class aiocord.model.enums.GuildFeature(data, *args, **kwargs)

Bases: StrEnum

Source: Guild Features

animated_banner = 'ANIMATED_BANNER'

animated_icon = 'ANIMATED_ICON'

application_command_permissions_v2 = 'APPLICATION_COMMAND_PERMISSIONS_V2'

auto_moderation = 'AUTO_MODERATION'

banner = 'BANNER'

community = 'COMMUNITY'

creator_monetizable_provisional = 'CREATOR_MONETIZABLE_PROVISIONAL'

creator_store_page = 'CREATOR_STORE_PAGE'

developer_support_server = 'DEVELOPER_SUPPORT_SERVER'

discoverable = 'DISCOVERABLE'

featurable = 'FEATURABLE'

invites_disabled = 'INVITES_DISABLED'

invite_splash = 'INVITE_SPLASH'

member_verification_gate_enabled = 'MEMBER_VERIFICATION_GATE_ENABLED'

more_stickers = 'MORE_STICKERS'

news = 'NEWS'

partnered = 'PARTNERED'

preview_enabled = 'PREVIEW_ENABLED'

role_icons = 'ROLE_ICONS'

role_subscriptions_available_for_purchase = 'ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE'

role_subscriptions_enabled = 'ROLE_SUBSCRIPTIONS_ENABLED'

ticketed_events_enabled = 'TICKETED_EVENTS_ENABLED'

vanity_url = 'VANITY_URL'

verified = 'VERIFIED'

vip_regions = 'VIP_REGIONS'

welcome_screen_enabled = 'WELCOME_SCREEN_ENABLED'

raid_alerts_disabled = 'RAID_ALERTS_DISABLED'

text_in_voice_enabled = 'TEXT_IN_VOICE_ENABLED'

class aiocord.model.enums.GuildMFALevel(data, *args, **kwargs)

Bases: IntEnum

Source: Mfa Level

none = 0

elevated = 1

class aiocord.model.enums.GuildNSFWLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Nsfw Level

default = 0

explicit = 1

safe = 2

age_restricted = 3

class aiocord.model.enums.GuildSystemChannelFlags(data, *args, **kwargs)

Bases: IntFlag

Source: System Channel Flags

suppress_join_notifications = 1

suppress_premium_subscriptions = 2

suppress_guild_reminder_notifications = 4

suppress_join_notification_replies = 8

suppress_role_subscription_purchase_notifications = 16

suppress_role_subscription_purchase_notification_replies = 32

class aiocord.model.enums.GuildPremiumTier(data, *args, **kwargs)

Bases: IntEnum

Source: Premium Tier

none = 0

tier_1 = 1

tier_2 = 2

tier_3 = 3

class aiocord.model.enums.GuildMemberFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Guild Member Flags

did_rejoin = 1

completed_onboarding = 2

bypasses_verification = 4

started_onboarding = 8

class aiocord.model.enums.IntegrationExpireBehaviorType(data, *args, **kwargs)

Bases: IntEnum

Source: Integration Expire Behaviors

remove_role = 0

kick = 1

class aiocord.model.enums.GuildOnboardingPromptType(data, *args, **kwargs)

Bases: IntEnum

Source: Prompt Types

multiple_choice = 0

dropdown = 1

class aiocord.model.enums.GuildScheduledEventPrivacyLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Privacy Level

guild_only = 2

class aiocord.model.enums.GuildScheduledEventEntityType(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Entity Types

stage_instance = 1

voice = 2

external = 3

class aiocord.model.enums.GuildScheduledEventStatus(data, *args, **kwargs)

Bases: IntEnum

Source: Guild Scheduled Event Status

scheduled = 1

active = 2

completed = 3

canceled = 4

class aiocord.model.enums.InviteTargetType(data, *args, **kwargs)

Bases: IntEnum

Source: Invite Target Types

stream = 1

embedded_application = 2

class aiocord.model.enums.StageInstancePrivacyLevel(data, *args, **kwargs)

Bases: IntEnum

Source: Privacy Level

public = 1

guild_only = 2

class aiocord.model.enums.StickerType(data, *args, **kwargs)

Bases: IntEnum

Source: Sticker Types

standard = 1

guild = 2

class aiocord.model.enums.StickerFormatType(data, *args, **kwargs)

Bases: IntEnum

Source: Sticker Format Types

png = 1

apng = 2

lottie = 3

gif = 4

class aiocord.model.enums.UserFlags(data, *args, **kwargs)

Bases: IntFlag

Source: User Flags

staff = 1

partner = 2

hypesquad = 4

bug_hunter_level_1 = 8

hypesquad_online_house_1 = 64

hypesquad_online_house_2 = 128

hypesquad_online_house_3 = 256

premium_early_supporter = 512

team_pseudo_user = 1024

bug_hunter_level_2 = 16384

verified_bot = 65536

verified_developer = 131072

certified_moderator = 262144

bot_http_interactions = 524288

active_developer = 4194304

class aiocord.model.enums.UserPremiumType(data, *args, **kwargs)

Bases: IntEnum

Source: Premium Types

none = 0

nitro_classic = 1

nitro = 2

nitro_basic = 3

class aiocord.model.enums.ConnectionVisibilityType(data, *args, **kwargs)

Bases: IntEnum

Source: Visibility Types

none = 0

everyone = 1

class aiocord.model.enums.WebhookType(data, *args, **kwargs)

Bases: IntEnum

Source: Webhook Types

incoming = 1

channel_follower = 2

application = 3

class aiocord.model.enums.ActivityType(data, *args, **kwargs)

Bases: IntEnum

Source: Activity Types

game = 0

streaming = 1

listening = 2

watching = 3

custom = 4

competing = 5

class aiocord.model.enums.ActivityFlags(data, *args, **kwargs)

Bases: IntFlag

Source: Activity Types

instance = 1

join = 2

spectate = 4

join_request = 8

sync = 16

play = 32

party_privacy_friends = 64

party_privacy_voice_channel = 128

embedded = 256

class aiocord.model.enums.TeamMemberMembershipState(data, *args, **kwargs)

Bases: IntEnum

Source: Data Models Membership State Enum

invited = 1

accepted = 2

class aiocord.model.enums.WidgetStyleOption(data, *args, **kwargs)

Bases: StrEnum

Source: Widget Style Options

shield = 'shield'

banner1 = 'banner1'

banner2 = 'banner2'

banner3 = 'banner3'

banner4 = 'banner4'

class aiocord.model.enums.SpeechFlags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Source: Speaking Flags

microphone = 1

soundshare = 2

priority = 4

class aiocord.model.enums.TimestampStyle(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Source: Message Formatting Timestamp Styles

short_time = 't'

long_time = 'T'

short_date = 'd'

long_date = 'D'

short_date_time = 'f'

long_date_time = 'F'

relative_time = 'R'

class aiocord.model.enums.SKUType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Source: SKU Types

subscription = 5

subscription_group = 6

class aiocord.model.enums.SKUFlags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntFlag

Source: SKU Flags

available = 4

guild_subscription = 128

user_subscription = 256

class aiocord.model.enums.EntitlementOwnerType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Source: Entitlement Owner Type

guild_subscription = 1

user_subscription = 2

protocols

All data models that may be sent or received.

These can be used directly when formulating request payloads.

class aiocord.model.protocols.ApplicationCommand

Bases: TypedDict

id: Source:

type: Source:

application_id: Source:

guild_id: Source:

name: Source:

name_localizations: Source:

description: Source:

description_localizations: Source:

options: Source:

default_member_permissions: Source:

default_permission: Source:

nsfw: Source:

version: Source:

integration_types: Source:

contexts: Source:

class aiocord.model.protocols.ApplicationCommandOption

Bases: TypedDict

type: Source:

name: Source:

name_localizations: Source:

description: Source:

description_localizations: Source:

required: Source:

choices: Source:

options: Source:

channel_types: Source:

min_value: Source:

max_value: Source:

min_length: Source:

max_length: Source:

autocomplete: Source:

class aiocord.model.protocols.ApplicationCommandOptionChoice

Bases: TypedDict

name: Source:

name_localizations: Source:

value: Source:

class aiocord.model.protocols.GuildApplicationCommandPermissions

Bases: TypedDict

id: Source:

application_id: Source:

guild_id: Source:

permissions: Source:

class aiocord.model.protocols.ApplicationCommandPermission

Bases: TypedDict

id: Source:

type: Source:

permission: Source:

class aiocord.model.protocols.MessageActionRowComponent

Bases: TypedDict

type: Source:

components: Source:

class aiocord.model.protocols.MessageButtonComponent

Bases: TypedDict

type: Source:

style: Source:

label: Source:

emoji: Source:

custom_id: Source:

url: Source:

disabled: Source:

class aiocord.model.protocols.MessageSelectMenuComponent

Bases: TypedDict

type: Source:

custom_id: Source:

options: Source:

channel_types: Source:

placeholder: Source:

default_values: Source:

min_values: Source:

max_values: Source:

disabled: Source:

class aiocord.model.protocols.MessageSelectMenuComponentDefaultValue

Bases: TypedDict

id: Source:

type: Source:

class aiocord.model.protocols.MessageSelectMenuComponentOption

Bases: TypedDict

label: Source:

value: Source:

description: Source:

emoji: Source:

default: Source:

class aiocord.model.protocols.MessageTextInputComponent

Bases: TypedDict

type: Source:

custom_id: Source:

style: Source:

label: Source:

min_length: Source:

max_length: Source:

required: Source:

value: Source:

placeholder: Source:

class aiocord.model.protocols.Interaction

Bases: TypedDict

id: Source:

application_id: Source:

type: Source:

data: Source:

guild_id: Source:

channel: Source:

channel_id: Source:

member: Source:

user: Source:

token: Source:

version: Source:

message: Source:

app_permissions: Source:

locale: Source:

guild_locale: Source:

entitlements: Source:

authorizing_integration_owners: Source:

context: Source:

class aiocord.model.protocols.ApplicationCommandInteractionData

Bases: TypedDict

id: Source:

name: Source:

type: Source:

resolved: Source:

options: Source:

guild_id: Source:

target_id: Source:

class aiocord.model.protocols.ApplicationCommandInteractionDataOption

Bases: TypedDict

name: Source:

type: Source:

value: Source:

options: Source:

focused: Source:

class aiocord.model.protocols.MessageComponentInteractionData

Bases: TypedDict

custom_id: Source:

component_type: Source:

class aiocord.model.protocols.ModalSubmitInteractionData

Bases: TypedDict

custom_id: Source:

components: Source:

class aiocord.model.protocols.ResolvedInteractionData

Bases: TypedDict

users: Source:

guild_members: Source:

channels: Source:

messages: Source:

attachments: Source:

class aiocord.model.protocols.MessageInteraction

Bases: TypedDict

id: Source:

type: Source:

name: Source:

user: Source:

guild_member: Source:

class aiocord.model.protocols.InteractionResponse

Bases: TypedDict

type: Source:

data: Source:

class aiocord.model.protocols.MessageInteractionResponse

Bases: TypedDict

tts: Source:

content: Source:

embeds: Source:

allowed_mentions: Source:

flags: Source:

components: Source:

attachments: Source:

class aiocord.model.protocols.AutocompleteInteractionResponse

Bases: TypedDict

choices: Source:

class aiocord.model.protocols.ModalInteractionResponse

Bases: TypedDict

custom_id: Source:

title: Source:

components: Source:

class aiocord.model.protocols.Application

Bases: TypedDict

id: Source:

name: Source:

icon: Source:

description: Source:

rpc_origins: Source:

bot_public: Source:

bot_require_code_grant: Source:

terms_of_service_url: Source:

privacy_policy_url: Source:

owner: Source:

verify_key: Source:

team: Source:

guild_id: Source:

primary_sku_id: Source:

slug: Source:

cover_image: Source:

flags: Source:

tags: Source:

install_params: Source:

custom_install_url: Source:

role_connections_verification_url: Source:

integration_types_config: Source:

class aiocord.model.protocols.ApplicationIntegrationTypeConfiguration

Bases: TypedDict

oauth2_install_params: Source:

class aiocord.model.protocols.ApplicationInstallParams

Bases: TypedDict

scopes: Source:

permissions: Source:

class aiocord.model.protocols.ApplicationRoleConnectionMetadata

Bases: TypedDict

type: Source:

key: Source:

name: Source:

name_localizations: Source:

description: Source:

description_localizations: Source:

class aiocord.model.protocols.AuditLog

Bases: TypedDict

application_commands: Source:

audit_log_entries: Source:

auto_moderation_rules: Source:

guild_scheduled_events: Source:

integrations: Source:

threads: Source:

users: Source:

webhooks: Source:

class aiocord.model.protocols.AuditLogEntry

Bases: TypedDict

target_id: Source:

changes: Source:

user_id: Source:

id: Source:

action_type: Source:

options: Source:

reason: Source:

class aiocord.model.protocols.OptionalAuditLogEntryInfo

Bases: TypedDict

application_id: Source:

auto_moderation_rule_name: Source:

auto_moderation_rule_trigger_type: Source:

channel_id: Source:

count: Source:

delete_member_days: Source:

id: Source:

members_removed: Source:

message_id: Source:

role_name: Source:

type: Source:

class aiocord.model.protocols.AuditLogChange

Bases: TypedDict

new_value: Source:

old_value: Source:

key: Source:

class aiocord.model.protocols.AutoModerationRule

Bases: TypedDict

id: Source:

guild_id: Source:

name: Source:

creator_id: Source:

event_type: Source:

trigger_type: Source:

trigger_metadata: Source:

actions: Source:

enabled: Source:

exempt_roles: Source:

exempt_channels: Source:

class aiocord.model.protocols.AutoModerationTriggerMetadata

Bases: TypedDict

keyword_filter: Source:

regex_patterns: Source:

presets: Source:

allow_list: Source:

mention_total_limit: Source:

mention_raid_protection_enabled: Source:

class aiocord.model.protocols.AutoModerationAction

Bases: TypedDict

type: Source:

metadata: Source:

class aiocord.model.protocols.AutoModerationActionMetadata

Bases: TypedDict

channel_id: Source:

duration_seconds: Source:

custom_message: Source:

class aiocord.model.protocols.Channel

Bases: TypedDict

id: Source:

type: Source:

guild_id: Source:

position: Source:

permission_overwrites: Source:

name: Source:

topic: Source:

nsfw: Source:

last_message_id: Source:

bitrate: Source:

user_limit: Source:

rate_limit_per_user: Source:

recipients: Source:

icon: Source:

owner_id: Source:

application_id: Source:

managed: Source:

parent_id: Source:

last_pin_timestamp: Source:

rtc_region: Source:

video_quality_mode: Source:

message_count: Source:

member_count: Source:

thread_metadata: Source:

member: Source:

default_auto_archive_duration: Source:

permissions: Source:

flags: Source:

total_message_sent: Source:

available_tags: Source:

applied_tags: Source:

default_reaction_emoji: Source:

default_thread_rate_limit_per_user: Source:

default_sort_order: Source:

default_forum_layout: Source:

class aiocord.model.protocols.Message

Bases: TypedDict

id: Source:

channel_id: Source:

author: Source:

content: Source:

timestamp: Source:

edited_timestamp: Source:

tts: Source:

mention_everyone: Source:

mentions: Source:

mention_roles: Source:

mention_channels: Source:

attachments: Source:

embeds: Source:

reactions: Source:

nonce: Source:

pinned: Source:

webhook_id: Source:

type: Source:

activity: Source:

application: Source:

application_id: Source:

message_reference: Source:

flags: Source:

referenced_message: Source:

interaction: Source:

thread: Source:

components: Source:

stickers: Source:

position: Source:

role_subscription_data: Source:

interaction_metadata: Source:

class aiocord.model.protocols.MessageActivity

Bases: TypedDict

type: Source:

party_id: Source:

class aiocord.model.protocols.MessageInteractionMetadata

Bases: TypedDict

id: Source:

type: Source:

user_id: Source:

authorizing_integration_owners: Source:

original_response_message_id: Source:

interacted_message_id: Source:

triggering_interaction_metadata: Source:

class aiocord.model.protocols.MessageReference

Bases: TypedDict

message_id: Source:

channel_id: Source:

guild_id: Source:

fail_if_not_exists: Source:

class aiocord.model.protocols.Reaction

Bases: TypedDict

count: Source:

me: Source:

emoji: Source:

class aiocord.model.protocols.FollowedChannel

Bases: TypedDict

channel_id: Source:

webhook_id: Source:

class aiocord.model.protocols.Overwrite

Bases: TypedDict

id: Source:

type: Source:

allow: Source:

deny: Source:

class aiocord.model.protocols.ThreadMetadata

Bases: TypedDict

archived: Source:

auto_archive_duration: Source:

archive_timestamp: Source:

locked: Source:

invitable: Source:

create_timestamp: Source:

class aiocord.model.protocols.ThreadMember

Bases: TypedDict

thread_id: Source:

user_id: Source:

join_timestamp: Source:

flags: Source:

member: Source:

class aiocord.model.protocols.DefaultReaction

Bases: TypedDict

emoji_id: Source:

emoji_name: Source:

class aiocord.model.protocols.ForumTag

Bases: TypedDict

id: Source:

name: Source:

moderated: Source:

emoji_id: Source:

emoji_name: Source:

class aiocord.model.protocols.Embed

Bases: TypedDict

title: Source:

type: Source:

description: Source:

url: Source:

timestamp: Source:

color: Source:

footer: Source:

image: Source:

thumbnail: Source:

video: Source:

provider: Source:

author: Source:

fields: Source:

class aiocord.model.protocols.EmbedThumbnail

Bases: TypedDict

url: Source:

proxy_url: Source:

height: Source:

width: Source:

class aiocord.model.protocols.EmbedVideo

Bases: TypedDict

url: Source:

proxy_url: Source:

height: Source:

width: Source:

class aiocord.model.protocols.EmbedImage

Bases: TypedDict

url: Source:

proxy_url: Source:

height: Source:

width: Source:

class aiocord.model.protocols.EmbedProvider

Bases: TypedDict

name: Source:

url: Source:

class aiocord.model.protocols.EmbedAuthor

Bases: TypedDict

name: Source:

url: Source:

icon_url: Source:

proxy_icon_url: Source:

class aiocord.model.protocols.EmbedFooter

Bases: TypedDict

text: Source:

icon_url: Source:

proxy_icon_url: Source:

class aiocord.model.protocols.EmbedField

Bases: TypedDict

name: Source:

value: Source:

inline: Source:

class aiocord.model.protocols.Attachment

Bases: TypedDict

id: Source:

filename: Source:

description: Source:

content_type: Source:

size: Source:

url: Source:

proxy_url: Source:

height: Source:

width: Source:

ephemeral: Source:

duration_secs: Source:

waveform: Source:

class aiocord.model.protocols.AllowedMentions

Bases: TypedDict

parse: Source:

roles: Source:

users: Source:

replied_user: Source:

class aiocord.model.protocols.RoleSubscriptionData

Bases: TypedDict

role_subscription_listing_id: Source:

tier_name: Source:

total_months_subscribed: Source:

is_renewal: Source:

class aiocord.model.protocols.Emoji

Bases: TypedDict

id: Source:

name: Source:

roles: Source:

user: Source:

require_colons: Source:

managed: Source:

animated: Source:

available: Source:

class aiocord.model.protocols.Guild

Bases: TypedDict

id: Source:

name: Source:

icon: Source:

icon_hash: Source:

splash: Source:

discovery_splash: Source:

owner: Source:

owner_id: Source:

permissions: Source:

afk_channel_id: Source:

afk_timeout: Source:

widget_enabled: Source:

widget_channel_id: Source:

verification_level: Source:

default_message_notifications: Source:

explicit_content_filter: Source:

roles: Source:

emojis: Source:

features: Source:

mfa_level: Source:

application_id: Source:

system_channel_id: Source:

system_channel_flags: Source:

rules_channel_id: Source:

max_presences: Source:

max_members: Source:

vanity_url_code: Source:

description: Source:

banner: Source:

premium_tier: Source:

premium_subscription_count: Source:

preferred_locale: Source:

public_updates_channel_id: Source:

max_video_channel_users: Source:

max_stage_video_channel_users: Source:

approximate_member_count: Source:

approximate_presence_count: Source:

welcome_screen: Source:

nsfw_level: Source:

stickers: Source:

premium_progress_bar_enabled: Source:

joined_at: Source:

large: Source:

unavailable: Source:

member_count: Source:

voice_states: Source:

members: Source:

channels: Source:

threads: Source:

presences: Source:

stage_instances: Source:

scheduled_events: Source:

safety_alerts_channel_id: Source:

class aiocord.model.protocols.GuildWidgetSettings

Bases: TypedDict

enabled: Source:

channel_id: Source:

class aiocord.model.protocols.GuildWidget

Bases: TypedDict

id: Source:

name: Source:

instant_invite: Source:

channels: Source:

members: Source:

presence_count: Source:

class aiocord.model.protocols.GuildMember

Bases: TypedDict

user: Source:

nick: Source:

avatar: Source:

roles: Source:

joined_at: Source:

premium_since: Source:

deaf: Source:

mute: Source:

flags: Source:

pending: Source:

permissions: Source:

communication_disabled_until: Source:

class aiocord.model.protocols.Integration

Bases: TypedDict

id: Source:

name: Source:

type: Source:

enabled: Source:

syncing: Source:

role_id: Source:

enable_emoticons: Source:

expire_behavior: Source:

expire_grace_period: Source:

user: Source:

account: Source:

synced_at: Source:

subscriber_count: Source:

revoked: Source:

application: Source:

scopes: Source:

class aiocord.model.protocols.IntegrationAccount

Bases: TypedDict

id: Source:

name: Source:

class aiocord.model.protocols.IntegrationApplication

Bases: TypedDict

id: Source:

name: Source:

icon: Source:

description: Source:

bot: Source:

class aiocord.model.protocols.Ban

Bases: TypedDict

reason: Source:

user: Source:

class aiocord.model.protocols.WelcomeScreen

Bases: TypedDict

description: Source:

welcome_channels: Source:

class aiocord.model.protocols.WelcomeScreenChannel

Bases: TypedDict

channel_id: Source:

description: Source:

emoji_id: Source:

emoji_name: Source:

class aiocord.model.protocols.GuildOnboarding

Bases: TypedDict

guild_id: Source:

prompts: Source:

default_channel_ids: Source:

enabled: Source:

class aiocord.model.protocols.GuildOnboardingPrompt

Bases: TypedDict

id: Source:

type: Source:

options: Source:

title: Source:

single_select: Source:

required: Source:

in_onboarding: Source:

class aiocord.model.protocols.GuildOnboardingPromptOption

Bases: TypedDict

id: Source:

channel_ids: Source:

role_ids: Source:

emoji: Source:

title: Source:

description: Source:

class aiocord.model.protocols.GuildScheduledEvent

Bases: TypedDict

id: Source:

guild_id: Source:

channel_id: Source:

creator_id: Source:

name: Source:

description: Source:

scheduled_start_time: Source:

scheduled_end_time: Source:

privacy_level: Source:

status: Source:

entity_type: Source:

entity_id: Source:

entity_metadata: Source:

creator: Source:

user_count: Source:

image: Source:

class aiocord.model.protocols.GuildScheduledEventEntityMetadata

Bases: TypedDict

location: Source:

class aiocord.model.protocols.GuildScheduledEventUser

Bases: TypedDict

guild_scheduled_event_id: Source:

user: Source:

member: Source:

class aiocord.model.protocols.GuildTemplate

Bases: TypedDict

code: Source:

name: Source:

description: Source:

usage_count: Source:

creator_id: Source:

creator: Source:

created_at: Source:

updated_at: Source:

source_guild_id: Source:

serialized_source_guild: Source:

is_dirty: Source:

class aiocord.model.protocols.Invite

Bases: TypedDict

code: Source:

guild: Source:

channel: Source:

inviter: Source:

target_type: Source:

target_user: Source:

target_application: Source:

approximate_presence_count: Source:

approximate_member_count: Source:

expires_at: Source:

stage_instance: Source:

guild_scheduled_event: Source:

uses: Source:

max_uses: Source:

max_age: Source:

temporary: Source:

created_at: Source:

class aiocord.model.protocols.InviteStageInstance

Bases: TypedDict

members: Source:

participant_count: Source:

speaker_count: Source:

topic: Source:

class aiocord.model.protocols.StageInstance

Bases: TypedDict

id: Source:

guild_id: Source:

channel_id: Source:

topic: Source:

privacy_level: Source:

discoverable_disabled: Source:

guild_scheduled_event_id: Source:

class aiocord.model.protocols.Sticker

Bases: TypedDict

id: Source:

pack_id: Source:

name: Source:

description: Source:

tags: Source:

asset: Source:

type: Source:

format_type: Source:

available: Source:

guild_id: Source:

user: Source:

sort_value: Source:

class aiocord.model.protocols.StickerPack

Bases: TypedDict

id: Source:

stickers: Source:

name: Source:

sku_id: Source:

cover_sticker_id: Source:

description: Source:

banner_asset_id: Source:

class aiocord.model.protocols.User

Bases: TypedDict

id: Source:

username: Source:

discriminator: Source:

avatar: Source:

bot: Source:

system: Source:

mfa_enabled: Source:

banner: Source:

accent_color: Source:

locale: Source:

verified: Source:

email: Source:

flags: Source:

premium_type: Source:

public_flags: Source:

class aiocord.model.protocols.Connection

Bases: TypedDict

id: Source:

name: Source:

type: Source:

revoked: Source:

integrations: Source:

verified: Source:

friend_sync: Source:

show_activity: Source:

two_way_link: Source:

visibility: Source:

class aiocord.model.protocols.ApplicationRoleConnection

Bases: TypedDict

platform_name: Source:

platform_username: Source:

metadata: Source:

class aiocord.model.protocols.VoiceState

Bases: TypedDict

guild_id: Source:

channel_id: Source:

user_id: Source:

member: Source:

session_id: Source:

deaf: Source:

mute: Source:

self_deaf: Source:

self_mute: Source:

self_stream: Source:

self_video: Source:

suppress: Source:

request_to_speak_timestamp: Source:

class aiocord.model.protocols.VoiceRegion

Bases: TypedDict

id: Source:

name: Source:

optimal: Source:

deprecated: Source:

custom: Source:

class aiocord.model.protocols.Webhook

Bases: TypedDict

id: Source:

type: Source:

guild_id: Source:

channel_id: Source:

user: Source:

name: Source:

avatar: Source:

token: Source:

application_id: Source:

source_guild: Source:

source_channel: Source:

url: Source:

class aiocord.model.protocols.Presence

Bases: TypedDict

user: Source:

guild_id: Source:

status: Source:

activities: Source:

client_status: Source:

class aiocord.model.protocols.ClientStatus

Bases: TypedDict

desktop: Source:

mobile: Source:

web: Source:

class aiocord.model.protocols.Activity

Bases: TypedDict

name: Source:

type: Source:

url: Source:

created_at: Source:

timestamps: Source:

application_id: Source:

details: Source:

state: Source:

emoji: Source:

party: Source:

assets: Source:

secrets: Source:

instance: Source:

flags: Source:

buttons: Source:

class aiocord.model.protocols.ActivityTimestamps

Bases: TypedDict

start: Source:

end: Source:

class aiocord.model.protocols.ActivityParty

Bases: TypedDict

id: Source:

size: Source:

class aiocord.model.protocols.ActivityAssets

Bases: TypedDict

large_image: Source:

large_text: Source:

small_image: Source:

small_text: Source:

class aiocord.model.protocols.ActivitySecrets

Bases: TypedDict

join: Source:

spectate: Source:

match: Source:

class aiocord.model.protocols.ActivityButton

Bases: TypedDict

label: Source:

url: Source:

class aiocord.model.protocols.Role

Bases: TypedDict

id: Source:

name: Source:

color: Source:

hoist: Source:

icon: Source:

unicode_emoji: Source:

position: Source:

permissions: Source:

managed: Source:

mentionable: Source:

tags: Source:

class aiocord.model.protocols.RoleTags

Bases: TypedDict

bot_id: Source:

integration_id: Source:

premium_subscriber: Source:

subscription_listing_id: Source:

available_for_purchase: Source:

guild_connections: Source:

class aiocord.model.protocols.Team

Bases: TypedDict

icon: Source:

id: Source:

members: Source:

name: Source:

owner_user_id: Source:

class aiocord.model.protocols.TeamMember

Bases: TypedDict

membership_state: Source:

permissions: Source:

team_id: Source:

user: Source:

class aiocord.model.protocols.SKU

Bases: TypedDict

id: Source:

type: Source:

application_id: Source:

name: Source:

slug: Source:

flags: Source:

class aiocord.model.protocols.Entitlement

Bases: TypedDict

id: Source:

sku_id: Source:

application_id: Source:

user_id: Source:

type: Source:

deleted: Source:

starts_at: Source:

ends_at: Source:

guild_id: Source:

objects

Dynamic versions of models that may be updated at any point.

These will be found in responses or cached during live connections.

class aiocord.model.objects.ApplicationCommand(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommand]

Source: Application Command Structure

id: Source:

Source: id

type: Source:

Source: type

application_id: Source:

Source: application_id

guild_id: Source:

Source: guild_id

name: Source:

Source: name

name_localizations: Source:

Source: name_localizations

description: Source:

Source: description

description_localizations: Source:

Source: description_localizations

options: Source:

Source: options

default_member_permissions: Source:

Source: default_member_permissions

dm_permission: Source:

Source: dm_permission (deprecated)

default_permission: Source:

Source: default_permission

nsfw: Source:

Source: nsfw

version: Source:

Source: version

integration_types: Source:

Source: integration_types

context_types: Source:

Source: contexts

mention()

Get the mention.

class aiocord.model.objects.ApplicationCommandOption(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandOption]

Source: Application Command Option Structure

type: Source:

Source: type

name: Source:

Source: name

name_localizations: Source:

Source: name_localizations

description: Source:

Source: description

description_localizations: Source:

Source: description_localizations

required: Source:

Source: required

choices: Source:

Source: choices

options: Source:

Source: options

channel_types: Source:

Source: channel_types

min_value: Source:

Source: min_value

max_value: Source:

Source: max_value

min_length: Source:

Source: min_length

max_length: Source:

Source: max_length

autocomplete: Source:

Source: autocomplete

class aiocord.model.objects.ApplicationCommandOptionChoice(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandOptionChoice]

Source: Application Command Option Choice Structure

name: Source:

Source: name

name_localizations: Source:

Source: name_localizations

value: Source:

Source: value

class aiocord.model.objects.GuildApplicationCommandPermissions(data: _DataV, /, *, unique=False)

Bases: Object[GuildApplicationCommandPermissions]

DocumenGuild Application Command Permissions Structure </interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure>`

id: Source:

application_id: Source:

guild_id: Source:

permissions: Source:

class aiocord.model.objects.ApplicationCommandPermission(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandPermission]

DocumenApplication Command Permissions Structure </interactions/application-commands#application-command-permissions-object-application-command-permissions-structure>`

id: Source:

type: Source:

permission: Source:

class aiocord.model.objects.MessageActionRowComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageActionRowComponent]

Source: Action Rows

type: Source: = (<function MessageActionRowComponent.<lambda>>, <function _update>, False)

components: Source:

Source: components

class aiocord.model.objects.MessageButtonComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageButtonComponent]

Source: Button Structure

type: Source:

Source: type

style: Source:

Source: style

label: Source:

Source: label

emoji: Source:

Source: emoji

custom_id: Source:

Source: custom_id

url: Source:

Source: url

disabled: Source:

Source: disabled

class aiocord.model.objects.MessageSelectMenuComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponent]

Source: Select Menu Structure

type: Source:

Source: type

custom_id: Source:

Source: custom_id

options: Source:

Source: options

channel_types: Source:

Source: channel_types

placeholder: Source:

Source: placeholder

default_values: Source:

Source: default_values

min_values: Source:

Source: min_values

max_values: Source:

Source: max_values

disabled: Source:

Source: disabled

class aiocord.model.objects.MessageSelectMenuComponentDefaultValue(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponentDefaultValue]

Source: Select Default Value Structure

id: Source:

Source: id

type: Source:

Source: type

class aiocord.model.objects.MessageSelectMenuComponentOption(data: _DataV, /, *, unique=False)

Bases: Object[MessageSelectMenuComponentOption]

Source: Select Option Structure

label: Source:

Source: label

value: Source:

Source: value

description: Source:

Source: description

emoji: Source:

Source: emoji

default: Source:

Source: default

class aiocord.model.objects.MessageTextInputComponent(data: _DataV, /, *, unique=False)

Bases: Object[MessageTextInputComponent]

Source: Text Inputs Text Input Structure

type: Source:

Source: type

custom_id: Source:

Source: custom_id

style: Source:

Source: style

label: Source:

Source: label

min_length: Source:

Source: min_length

max_length: Source:

Source: max_length

required: Source:

Source: required

value: Source:

Source: value

placeholder: Source:

Source: placeholder

class aiocord.model.objects.Interaction(data: _DataV, /, *, unique=False)

Bases: Object[Interaction]

Source: Interaction Structure

id: Source:

Source: id

application_id: Source:

Source: application_id

type: Source:

Source: type

data: Source:

Source: data

guild_id: Source:

Source: guild_id

channel: Source:

Source: channel

channel_id: Source:

Source: channel_id

member: Source:

Source: member

user: Source:

Source: user

token: Source:

Source: token

version: Source:

Source: version

message: Source:

Source: message

app_permissions: Source:

Source: app_permissions

locale: Source:

Source: locale

guild_locale: Source:

Source: guild_locale

entitlements: Source:

Source: entitlements

authorizing_integration_owners: Source:

Source: authorizing_integration_owners

context: Source:

Source: context

class aiocord.model.objects.ApplicationCommandInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandInteractionData]

Source: Application Command Data Structure

id: Source:

Source: id

name: Source:

Source: name

type: Source:

Source: type

resolved: Source:

Source: resolved

options: Source:

Source: options

guild_id: Source:

Source: guild_id

target_id: Source:

Source: target_id

class aiocord.model.objects.ApplicationCommandInteractionDataOption(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationCommandInteractionDataOption]

Source: Application Command Interaction Data Option Structure

name: Source:

Source: name

type: Source:

Source: type

value: Source:

Source: value

options: Source:

Source: options

focused: Source:

Source: focused

class aiocord.model.objects.MessageComponentInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[MessageComponentInteractionData]

Source: Message Component Data Structure

custom_id: Source:

Source: custom_id

component_type: Source:

Source: component_type

values: Source:

Source: values

class aiocord.model.objects.ModalSubmitInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ModalSubmitInteractionData]

Source: Modal Submit Data Structure

custom_id: Source:

Source: custom_id

components: Source:

Source: components

class aiocord.model.objects.ResolvedInteractionData(data: _DataV, /, *, unique=False)

Bases: Object[ResolvedInteractionData]

Source: Resolved Data Structure

users: Source:

Source: users

guild_members: Source:

Source: guild_members

channels: Source:

Source: channels

messages: Source:

Source: messages

attachments: Source:

Source: attachments

class aiocord.model.objects.MessageInteraction(data: _DataV, /, *, unique=False)

Bases: Object[MessageInteraction]

Source: Message Interaction Structure

id: Source:

Source: id

type: Source:

Source: type

name: Source:

Source: name

user: Source:

Source: user

guild_member: Source:

Source: guild_member

class aiocord.model.objects.InteractionResponse(data: _DataV, /, *, unique=False)

Bases: Object[InteractionResponse]

Source: Interaction Response Structure

type: Source:

Source: type

data: Source:

Source: data

class aiocord.model.objects.Application(data: _DataV, /, *, unique=False)

Bases: Object[Application]

Source: Application Structure

id: Source:

Source: id

name: Source:

Source: name

icon: Source:

Source: icon

description: Source:

Source: description

rpc_origins: Source:

Source: rpc_origins

bot_public: Source:

Source: bot_public

bot_require_code_grant: Source:

Source: bot_require_code_grant

terms_of_service_url: Source:

Source: terms_of_service_url

privacy_policy_url: Source:

Source: privacy_policy_url

owner: Source:

Source: owner

verify_key: Source:

Source: verify_key

team: Source:

Source: team

guild_id: Source:

Source: guild_id

primary_sku_id: Source:

Source: primary_sku_id

slug: Source:

Source: slug

cover: Source:

Source: cover_image

flags: Source:

Source: flags

tags: Source:

Source: tags

install_params: Source:

Source: install_params

custom_install_url: Source:

Source: custom_install_url

role_connections_verification_url: Source:

Source: role_connections_verification_url

integration_type_configs: Source:

Source: integration_types_config

icon_url(**kwargs)

Get the icon url.

cover_url(**kwargs)

Get the cover url.

asset_url(asset_id, **kwargs)

Get the asset url.

class aiocord.model.objects.ApplicationIntegrationTypeConfiguration(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationIntegrationTypeConfiguration]

Source: Application Integration Type Configuration Object

oauth2_install_params: Source:

Source: oauth2_install_params

class aiocord.model.objects.ApplicationInstallParams(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationInstallParams]

Source: Install Params Structure

scopes: Source:

Source: scopes

permissions: Source:

Source: permissions

class aiocord.model.objects.ApplicationRoleConnectionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationRoleConnectionMetadata]

Source: Application Role Connection Metadata Structure

type: Source:

Source: type

key: Source:

Source: key

name: Source:

Source: name

name_localizations: Source:

Source: name_localizations

description: Source:

Source: description

description_localizations: Source:

Source: description_localizations

class aiocord.model.objects.AuditLog(data: _DataV, /, *, unique=False)

Bases: Object[AuditLog]

Source: Audit Log Structure

application_commands: Source:

Source: application_commands

audit_log_entries: Source:

Source: audit_log_entries

auto_moderation_rules: Source:

Source: auto_moderation_rules

guild_scheduled_events: Source:

Source: guild_scheduled_events

integrations: Source:

Source: integrations

threads: Source:

Source: threads

users: Source:

Source: users

webhooks: Source:

Source: webhooks

class aiocord.model.objects.AuditLogEntry(data: _DataV, /, *, unique=False)

Bases: Object[AuditLogEntry]

Source: Audit Log Entry Structure

target_id: Source:

Source: target_id

changes: Source:

Source: changes

user_id: Source:

Source: user_id

id: Source:

Source: id

action_type: Source:

Source: action_type

options: Source:

Source: options

reason: Source:

Source: reason

class aiocord.model.objects.OptionalAuditLogEntryInfo(data: _DataV, /, *, unique=False)

Bases: Object[OptionalAuditLogEntryInfo]

Source: Optional Audit Entry Info

application_id: Source:

Source: application_id

auto_moderation_rule_name: Source:

Source: auto_moderation_rule_name

auto_moderation_rule_trigger_type: Source:

Source: auto_moderation_rule_trigger_type

channel_id: Source:

Source: channel_id

count: Source:

Source: count

delete_member_days: Source:

Source: delete_member_days

id: Source:

Source: id

members_removed: Source:

Source: members_removed

message_id: Source:

Source: message_id

role_name: Source:

Source: role_name

type: Source:

Source: type

class aiocord.model.objects.AuditLogChange(data: _DataV, /, *, unique=False)

Bases: Object[AuditLogChange]

Source: Audit Log Change Structure

new_value: Source:

Source: new_value

old_value: Source:

Source: old_value

key: Source:

Source: key

class aiocord.model.objects.AutoModerationRule(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationRule]

Source: Trigger Metadata

id: Source:

Source: id

guild_id: Source:

Source: guild_id

name: Source:

Source: name

creator_id: Source:

Source: creator_id

event_type: Source:

Source: event_type

trigger_type: Source:

Source: trigger_type

trigger_metadata: Source:

Source: trigger_metadata

actions: Source:

Source: actions

enabled: Source:

Source: enabled

exempt_roles: Source:

Source: exempt_roles

exempt_channels: Source:

Source: exempt_channels

class aiocord.model.objects.AutoModerationTriggerMetadata(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationTriggerMetadata]

Source: Resources

keyword_filter: Source:

Source: keyword_filter

regex_patterns: Source:

Source: regex_patterns

presets: Source:

Source: presets

allow_list: Source:

Source: allow_list

mention_total_limit: Source:

Source: mention_total_limit

mention_raid_protection_enabled: Source:

Source: mention_total_limit

class aiocord.model.objects.AutoModerationAction(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationAction]

Source: Auto Moderation Action Structure

type: Source:

Source: type

metadata: Source:

Source: metadata

class aiocord.model.objects.AutoModerationActionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[AutoModerationActionMetadata]

Source: Resources

channel_id: Source:

Source: channel_id

duration_seconds: Source:

Source: duration_seconds

custom_message: Source:

Source: custom_message

class aiocord.model.objects.Channel(data: _DataV, /, *, unique=False)

Bases: Object[Channel]

Source: Channel Structure

id: Source:

Source: id

type: Source:

Source: type

guild_id: Source:

Source: guild_id

position: Source:

Source: position

permission_overwrites: Source:

Source: permission_overwrites

name: Source:

Source: name

topic: Source:

Source: topic

nsfw: Source:

Source: nsfw

last_message_id: Source:

Source: last_message_id

bitrate: Source:

Source: bitrate

user_limit: Source:

Source: user_limit

rate_limit_per_user: Source:

Source: rate_limit_per_user

recipients: Source:

Source: recipients

icon: Source:

Source: icon

owner_id: Source:

Source: owner_id

application_id: Source:

Source: application_id

managed: Source:

Source: managed

parent_id: Source:

Source: parent_id

last_pin_timestamp: Source:

Source: last_pin_timestamp

rtc_region: Source:

Source: rtc_region

video_quality_mode: Source:

Source: video_quality_mode

message_count: Source:

Source: message_count

member_count: Source:

Source: member_count

thread_metadata: Source:

Source: thread_metadata

member: Source:

Source: member

default_auto_archive_duration: Source:

Source: default_auto_archive_duration

permissions: Source:

Source: permissions

flags: Source:

Source: flags

total_message_sent: Source:

Source: total_message_sent

available_tags: Source:

Source: available_tags

applied_tags: Source:

Source: applied_tags

default_reaction_emoji: Source:

Source: default_reaction_emoji

default_thread_rate_limit_per_user: Source:

Source: default_thread_rate_limit_per_user

default_sort_order: Source:

Source: default_sort_order

default_forum_layout: Source:

Source: default_forum_layout

mention()

Get the mention.

class aiocord.model.objects.Message(data: _DataV, /, *, unique=False)

Bases: Object[Message]

Source: Message Structure

id: Source:

Source: id

channel_id: Source:

Source: channel_id

author: Source:

Source: author

content: Source:

Source: content

timestamp: Source:

Source: timestamp

edited_timestamp: Source:

Source: edited_timestamp

tts: Source:

Source: tts

mention_everyone: Source:

Source: mention_everyone

mentions: Source:

Source: mentions

mention_roles: Source:

Source: mention_roles

mention_channels: Source:

Source: mention_channels

attachments: Source:

Source: attachments

embeds: Source:

Source: embeds

reactions: Source:

Source: reactions

nonce: Source:

Source: nonce

pinned: Source:

Source: pinned

webhook_id: Source:

Source: webhook_id

type: Source:

Source: type

activity: Source:

Source: activity

application: Source:

Source: application

application_id: Source:

Source: application_id

message_reference: Source:

Source: message_reference

flags: Source:

Source: flags

referenced_message: Source:

Source: referenced_message

interaction: Source:

Source: interaction (deprecated)

thread: Source:

Source: thread

components: Source:

Source: components

stickers: Source:

Source: sticker_items

position: Source:

Source: position

role_subscription_data: Source:

Source: role_subscription_data

interaction_metadata: Source:

Source: interaction_metadata

class aiocord.model.objects.MessageActivity(data: _DataV, /, *, unique=False)

Bases: Object[MessageActivity]

Source: Message Activity Structure

type: Source:

Source: type

party_id: Source:

Source: party_id

class aiocord.model.objects.MessageInteractionMetadata(data: _DataV, /, *, unique=False)

Bases: Object[MessageInteractionMetadata]

Source: https://discord.com/developers/docsMessage Interaction Metadata Structure </resources/channel#message-interaction-metadata-object-message-interaction-metadata-structure

id: Source:

Source: id

type: Source:

Source: type

user_id: Source:

Source: user_id

authorizing_integration_owners: Source:

Source: authorizing_integration_owners

original_response_message_id: Source:

Source: original_response_message_id

interacted_message_id: Source:

Source: interacted_message_id

triggering_interaction_metadata: Source:

Source: triggering_interaction_metadata

class aiocord.model.objects.MessageReference(data: _DataV, /, *, unique=False)

Bases: Object[MessageReference]

Source: Message Reference Structure

message_id: Source:

Source: message_id

channel_id: Source:

Source: channel_id

guild_id: Source:

Source: guild_id

fail_if_not_exists: Source:

Source: fail_if_not_exists

class aiocord.model.objects.Reaction(data: _DataV, /, *, unique=False)

Bases: Object[Reaction]

Source: Reaction Structure

count: Source:

Source: count

me: Source:

Source: me

emoji: Source:

Source: emoji

class aiocord.model.objects.FollowedChannel(data: _DataV, /, *, unique=False)

Bases: Object[FollowedChannel]

Source: Followed Channel Structure

channel_id: Source:

Source: channel_id

webhook_id: Source:

Source: webhook_id

class aiocord.model.objects.Overwrite(data: _DataV, /, *, unique=False)

Bases: Object[Overwrite]

Source: Overwrite Structure

id: Source:

Source: id

type: Source:

Source: type

allow: Source:

Source: allow

deny: Source:

Source: deny

class aiocord.model.objects.ThreadMetadata(data: _DataV, /, *, unique=False)

Bases: Object[ThreadMetadata]

Source: Thread Metadata Structure

archived: Source:

Source: archived

auto_archive_duration: Source:

Source: auto_archive_duration

archive_timestamp: Source:

Source: archive_timestamp

locked: Source:

Source: locked

invitable: Source:

Source: invitable

create_timestamp: Source:

Source: create_timestamp

class aiocord.model.objects.ThreadMember(data: _DataV, /, *, unique=False)

Bases: Object[ThreadMember]

Source: Thread Member Structure

thread_id: Source:

Source: id

user_id: Source:

Source: user_id

join_timestamp: Source:

Source: join_timestamp

flags: Source:

Source: flags

member: Source:

Source: member

class aiocord.model.objects.DefaultReaction(data: _DataV, /, *, unique=False)

Bases: Object[DefaultReaction]

Source: Default Reaction Structure

emoji_id: Source:

Source: emoji_id

emoji_name: Source:

Source: emoji_name

class aiocord.model.objects.ForumTag(data: _DataV, /, *, unique=False)

Bases: Object[ForumTag]

Source: Forum Tag Structure

id: Source:

Source: id

name: Source:

Source: name

moderated: Source:

Source: moderated

emoji_id: Source:

Source: emoji_id

emoji_name: Source:

Source: emoji_name

class aiocord.model.objects.Embed(data: _DataV, /, *, unique=False)

Bases: Object[Embed]

Source: Embed Structure

title: Source:

Source: title

type: Source:

Source: type

description: Source:

Source: description

url: Source:

Source: url

timestamp: Source:

Source: timestamp

color: Source:

Source: color

footer: Source:

Source: footer

image: Source:

Source: image

thumbnail: Source:

Source: thumbnail

video: Source:

Source: video

provider: Source:

Source: provider

author: Source:

Source: author

fields: Source:

Source: fields

class aiocord.model.objects.EmbedThumbnail(data: _DataV, /, *, unique=False)

Bases: Object[EmbedThumbnail]

Source: Embed Thumbnail Structure

url: Source:

Source: url

proxy_url: Source:

Source: proxy_url

height: Source:

Source: height

width: Source:

Source: width

class aiocord.model.objects.EmbedVideo(data: _DataV, /, *, unique=False)

Bases: Object[EmbedVideo]

Source: Embed Video Structure

url: Source:

Source: url

proxy_url: Source:

Source: proxy_url

height: Source:

Source: height

width: Source:

Source: width

class aiocord.model.objects.EmbedImage(data: _DataV, /, *, unique=False)

Bases: Object[EmbedImage]

Source: Embed Image Structure

url: Source:

Source: url

proxy_url: Source:

Source: proxy_url

height: Source:

Source: height

width: Source:

Source: width

class aiocord.model.objects.EmbedProvider(data: _DataV, /, *, unique=False)

Bases: Object[EmbedProvider]

Source: Embed Provider Structure

name: Source:

Source: name

url: Source:

Source: url

class aiocord.model.objects.EmbedAuthor(data: _DataV, /, *, unique=False)

Bases: Object[EmbedAuthor]

Source: Embed Author Structure

name: Source:

Source: name

url: Source:

Source: url

icon_url: Source:

Source: icon_url

proxy_icon_url: Source:

Source: proxy_icon_url

class aiocord.model.objects.EmbedFooter(data: _DataV, /, *, unique=False)

Bases: Object[EmbedFooter]

Source: Embed Footer Structure

text: Source:

Source: text

icon_url: Source:

Source: icon_url

proxy_icon_url: Source:

Source: proxy_icon_url

class aiocord.model.objects.EmbedField(data: _DataV, /, *, unique=False)

Bases: Object[EmbedField]

Source: Embed Field Structure

name: Source:

Source: name

value: Source:

Source: value

inline: Source:

Source: inline

class aiocord.model.objects.Attachment(data: _DataV, /, *, unique=False)

Bases: Object[Attachment]

Source: Resources

id: Source:

Source: id

filename: Source:

Source: filename

description: Source:

Source: description

content_type: Source:

Source: content_type

size: Source:

Source: size

url: Source:

Source: url

proxy_url: Source:

Source: proxy_url

height: Source:

Source: height

width: Source:

Source: width

ephemeral: Source:

Source: ephemeral

duration_secs: Source:

Source: duration_secs

waveform: Source:

Source: waveform

class aiocord.model.objects.AllowedMentions(data: _DataV, /, *, unique=False)

Bases: Object[AllowedMentions]

Source: Allowed Mentions Structure

parse: Source:

Source: parse

roles: Source:

Source: roles

users: Source:

Source: users

replied_user: Source:

Source: replied_user

class aiocord.model.objects.RoleSubscriptionData(data: _DataV, /, *, unique=False)

Bases: Object[RoleSubscriptionData]

Source: Role Subscription Data Object

role_subscription_listing_id: Source:

Source: role_subscription_listing_id

tier_name: Source:

Source: tier_name

total_months_subscribed: Source:

Source: total_months_subscribed

is_renewal: Source:

Source: is_renewal

class aiocord.model.objects.Emoji(data: _DataV, /, *, unique=False)

Bases: Object[Emoji]

Source: Emoji Structure

id: Source:

Source: id

name: Source:

Source: name

roles: Source:

Source: roles

user: Source:

Source: user

require_colons: Source:

Source: require_colons

managed: Source:

Source: managed

animated: Source:

Source: animated

available: Source:

Source: available

mention()

Get the mention.

image_url(**kwargs)

Get the image url.

class aiocord.model.objects.Guild(data: _DataV, /, *, unique=False)

Bases: Object[Guild]

Source: Guild Structure | Guild Create Guild Create Extra Fields

id: Source:

Source: id

name: Source:

Source: name

icon: Source:

Source: icon

icon_hash: Source:

Source: icon_hash

splash: Source:

Source: splash

discovery_splash: Source:

Source: discovery_splash

owner: Source:

Source: owner

owner_id: Source:

Source: owner_id

permissions: Source:

Source: permissions

afk_channel_id: Source:

Source: afk_channel_id

afk_timeout: Source:

Source: afk_timeout

widget_enabled: Source:

Source: widget_enabled

widget_channel_id: Source:

Source: widget_channel_id

verification_level: Source:

Source: verification_level

default_message_notifications: Source:

Source: default_message_notifications

explicit_content_filter: Source:

Source: explicit_content_filter

roles: Source:

Source: roles

emojis: Source:

Source: emojis

features: Source:

Source: features

mfa_level: Source:

Source: mfa_level

application_id: Source:

Source: application_id

system_channel_id: Source:

Source: system_channel_id

system_channel_flags: Source:

Source: system_channel_flags

rules_channel_id: Source:

Source: rules_channel_id

max_presences: Source:

Source: max_presences

max_members: Source:

Source: max_members

vanity_url_code: Source:

Source: vanity_url_code

description: Source:

Source: description

banner: Source:

Source: banner

premium_tier: Source:

Source: premium_tier

premium_subscription_count: Source:

Source: premium_subscription_count

preferred_locale: Source:

Source: preferred_locale

public_updates_channel_id: Source:

Source: public_updates_channel_id

max_video_channel_users: Source:

Source: max_video_channel_users

max_stage_video_channel_users: Source:

Source: max_stage_video_channel_users

approximate_member_count: Source:

Source: approximate_member_count

approximate_presence_count: Source:

Source: approximate_presence_count

welcome_screen: Source:

Source: welcome_screen

nsfw_level: Source:

Source: nsfw_level

stickers: Source:

Source: stickers

premium_progress_bar_enabled: Source:

Source: premium_progress_bar_enabled

joined_at: Source:

Source: joined_at

large: Source:

Source: large

unavailable: Source:

Source: unavailable

member_count: Source:

Source: member_count

voice_states: Source:

Source: voice_states

members: Source:

Source: members

channels: Source:

Source: channels

threads: Source:

Source: threads

presences: Source:

Source: presences

stage_instances: Source:

Source: stage_instances

scheduled_events: Source:

Source: scheduled_events

safety_alerts_channel_id: Source:

Source: safety_alerts_channel_id

icon_url(**kwargs)

Get the icon url.

splash_url(**kwargs)

Get the splash url.

discovery_splash_url(**kwargs)

Get the discovery splash url.

banner_url(**kwargs)

Get the banner url.

class aiocord.model.objects.GuildWidgetSettings(data: _DataV, /, *, unique=False)

Bases: Object[GuildWidgetSettings]

Source: Guild Widget Settings Structure

enabled: Source:

Source: enabled

channel_id: Source:

Source: channel_id

class aiocord.model.objects.GuildWidget(data: _DataV, /, *, unique=False)

Bases: Object[GuildWidget]

Source: Guild Widget Structure

id: Source:

Source: id

name: Source:

Source: name

instant_invite: Source:

Source: instant_invite

channels: Source:

Source: channels

members: Source:

Source: members

presence_count: Source:

Source: presence_count

class aiocord.model.objects.GuildMember(data: _DataV, /, *, unique=False)

Bases: Object[GuildMember]

Source: Guild Member Structure | Guild Member Add Guild Member Add Extra Fields

guild_id: Source:

Source: guild_id

user: Source:

Source: user

nick: Source:

Source: nick

avatar: Source:

Source: avatar

roles: Source:

Source: roles

joined_at: Source:

Source: joined_at

premium_since: Source:

Source: premium_since

deaf: Source:

Source: deaf

mute: Source:

Source: mute

flags: Source:

Source: flags

pending: Source:

Source: pending

permissions: Source:

Source: permissions

communication_disabled_until: Source:

Source: communication_disabled_until

avatar_url(**kwargs)

Get the avatar url.

class aiocord.model.objects.Integration(data: _DataV, /, *, unique=False)

Bases: Object[Integration]

Source: Integration Structure

id: Source:

Source: id

name: Source:

Source: name

type: Source:

Source: type

enabled: Source:

Source: enabled

syncing: Source:

Source: syncing

role_id: Source:

Source: role_id

enable_emoticons: Source:

Source: enable_emoticons

expire_behavior: Source:

Source: expire_behavior

expire_grace_period: Source:

Source: expire_grace_period

user: Source:

Source: user

account: Source:

Source: account

synced_at: Source:

Source: synced_at

subscriber_count: Source:

Source: subscriber_count

revoked: Source:

Source: revoked

application: Source:

Source: application

scopes: Source:

Source: scopes

class aiocord.model.objects.IntegrationAccount(data: _DataV, /, *, unique=False)

Bases: Object[IntegrationAccount]

Source: Integration Account Structure

id: Source:

Source: id

name: Source:

Source: name

class aiocord.model.objects.IntegrationApplication(data: _DataV, /, *, unique=False)

Bases: Object[IntegrationApplication]

Source: Integration Application Structure

id: Source:

Source: id

name: Source:

Source: name

icon: Source:

Source: icon

description: Source:

Source: description

bot: Source:

Source: bot

class aiocord.model.objects.Ban(data: _DataV, /, *, unique=False)

Bases: Object[Ban]

Source: Ban Structure

reason: Source:

Source: reason

user: Source:

Source: user

class aiocord.model.objects.WelcomeScreen(data: _DataV, /, *, unique=False)

Bases: Object[WelcomeScreen]

Source: Welcome Screen Structure

description: Source:

Source: description

welcome_channels: Source:

Source: welcome_channels

class aiocord.model.objects.WelcomeScreenChannel(data: _DataV, /, *, unique=False)

Bases: Object[WelcomeScreenChannel]

Source: Welcome Screen Channel Structure

channel_id: Source:

Source: channel_id

description: Source:

Source: description

emoji_id: Source:

Source: emoji_id

emoji_name: Source:

Source: emoji_name

class aiocord.model.objects.GuildOnboarding(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboarding]

Source: Guild Onboarding Structure

guild_id: Source:

Source: guild_id

prompts: Source:

Source: prompts

default_channel_ids: Source:

Source: default_channel_ids

enabled: Source:

Source: enabled

class aiocord.model.objects.GuildOnboardingPrompt(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboardingPrompt]

Source: Onboarding Prompt Structure

id: Source:

Source: id

type: Source:

Source: type

options: Source:

Source: options

title: Source:

Source: title

single_select: Source:

Source: single_select

required: Source:

Source: required

in_onboarding: Source:

Source: in_onboarding

class aiocord.model.objects.GuildOnboardingPromptOption(data: _DataV, /, *, unique=False)

Bases: Object[GuildOnboardingPromptOption]

Source: Prompt Option Structure

id: Source:

Source: id

channel_ids: Source:

Source: channel_ids

role_ids: Source:

Source: role_ids

emoji: Source:

Source: emoji

title: Source:

Source: title

description: Source:

Source: description

class aiocord.model.objects.GuildScheduledEvent(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEvent]

Source: Guild Scheduled Event Structure

id: Source:

Source: id

guild_id: Source:

Source: guild_id

channel_id: Source:

Source: channel_id

creator_id: Source:

Source: creator_id

name: Source:

Source: name

description: Source:

Source: description

scheduled_start_time: Source:

Source: scheduled_start_time

scheduled_end_time: Source:

Source: scheduled_end_time

privacy_level: Source:

Source: privacy_level

status: Source:

Source: status

entity_type: Source:

Source: entity_type

entity_id: Source:

Source: entity_id

entity_metadata: Source:

Source: entity_metadata

creator: Source:

Source: creator

user_count: Source:

Source: user_count

cover: Source:

Source: image

cover_url(**kwargs)

Get the cover url.

class aiocord.model.objects.GuildScheduledEventEntityMetadata(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEventEntityMetadata]

Source: Guild Scheduled Event Entity Metadata

location: Source:

Source: location

class aiocord.model.objects.GuildScheduledEventUser(data: _DataV, /, *, unique=False)

Bases: Object[GuildScheduledEventUser]

Source: Guild Scheduled Event User Structure

guild_scheduled_event_id: Source:

Source: guild_scheduled_event_id

user: Source:

Source: user

member: Source:

Source: member

class aiocord.model.objects.GuildTemplate(data: _DataV, /, *, unique=False)

Bases: Object[GuildTemplate]

Source: Guild Template Structure

code: Source:

Source: code

name: Source:

Source: name

description: Source:

Source: description

usage_count: Source:

Source: usage_count

creator_id: Source:

Source: creator_id

creator: Source:

Source: creator

created_at: Source:

Source: created_at

updated_at: Source:

Source: updated_at

source_guild_id: Source:

Source: source_guild_id

serialized_source_guild: Source:

Source: serialized_source_guild

is_dirty: Source:

Source: is_dirty

class aiocord.model.objects.Invite(data: _DataV, /, *, unique=False)

Bases: Object[Invite]

Source: Invite Structure (Invite Metadata Structure)

code: Source:

Source: code

guild: Source:

Source: guild

channel: Source:

Source: channel

inviter: Source:

Source: inviter

target_type: Source:

Source: target_type

target_user: Source:

Source: target_user

target_application: Source:

Source: target_application

approximate_presence_count: Source:

Source: approximate_presence_count

approximate_member_count: Source:

Source: approximate_member_count

expires_at: Source:

Source: expires_at

stage_instance: Source:

Source: stage_instance

guild_scheduled_event: Source:

Source: guild_scheduled_event

uses: Source:

Source: uses

max_uses: Source:

Source: max_uses

max_age: Source:

Source: max_age

temporary: Source:

Source: temporary

created_at: Source:

Source: created_at

class aiocord.model.objects.InviteStageInstance(data: _DataV, /, *, unique=False)

Bases: Object[InviteStageInstance]

Source: Invite Stage Instance Structure

members: Source:

Source: members

participant_count: Source:

Source: participant_count

speaker_count: Source:

Source: speaker_count

topic: Source:

Source: topic

class aiocord.model.objects.StageInstance(data: _DataV, /, *, unique=False)

Bases: Object[StageInstance]

Source: Stage Instance Structure

id: Source:

Source: id

guild_id: Source:

Source: guild_id

channel_id: Source:

Source: channel_id

topic: Source:

Source: topic

privacy_level: Source:

Source: privacy_level

discoverable_disabled: Source:

Source: discoverable_disabled

guild_scheduled_event_id: Source:

Source: guild_scheduled_event_id

class aiocord.model.objects.Sticker(data: _DataV, /, *, unique=False)

Bases: Object[Sticker]

Source: Sticker Structure

id: Source:

Source: id

pack_id: Source:

Source: pack_id

name: Source:

Source: name

description: Source:

Source: description

tags: Source:

Source: tags

asset: Source:

Source: asset

type: Source:

Source: type

format_type: Source:

Source: format_type

available: Source:

Source: available

guild_id: Source:

Source: guild_id

user: Source:

Source: user

sort_value: Source:

Source: sort_value

image_url(**kwargs)

Get the icon url.

class aiocord.model.objects.StickerPack(data: _DataV, /, *, unique=False)

Bases: Object[StickerPack]

Source: Sticker Pack Structure

id: Source:

Source: id

stickers: Source:

Source: stickers

name: Source:

Source: name

sku_id: Source:

Source: sku_id

cover_sticker_id: Source:

Source: cover_sticker_id

description: Source:

Source: description

banner_asset_id: Source:

Source: banner_asset_id

banner_url(**kwargs)

Get the icon url.

class aiocord.model.objects.User(data: _DataV, /, *, unique=False)

Bases: Object[User]

Source: User Structure

id: Source:

Source: id

username: Source:

Source: username

discriminator: Source:

Source: discriminator

avatar: Source:

Source: avatar

bot: Source:

Source: bot

system: Source:

Source: system

mfa_enabled: Source:

Source: mfa_enabled

banner: Source:

Source: banner

accent_color: Source:

Source: accent_color

locale: Source:

Source: locale

verified: Source:

Source: verified

email: Source:

Source: email

flags: Source:

Source: flags

premium_type: Source:

Source: premium_type

public_flags: Source:

Source: public_flags

mention()

Get the mention.

banner_url(**kwargs)

Get the banner url.

avatar_url(**kwargs)

Get the avatar url.

class aiocord.model.objects.Connection(data: _DataV, /, *, unique=False)

Bases: Object[Connection]

Source: Connection Structure

id: Source:

Source: id

name: Source:

Source: name

type: Source:

Source: type

revoked: Source:

Source: revoked

integrations: Source:

Source: integrations

verified: Source:

Source: verified

friend_sync: Source:

Source: friend_sync

show_activity: Source:

Source: show_activity

two_way_link: Source:

Source: two_way_link

visibility: Source:

Source: visibility

class aiocord.model.objects.ApplicationRoleConnection(data: _DataV, /, *, unique=False)

Bases: Object[ApplicationRoleConnection]

Source: Application Role Connection Structure

platform_name: Source:

Source: platform_name

platform_username: Source:

Source: platform_username

metadata: Source:

Source: metadata

class aiocord.model.objects.VoiceState(data: _DataV, /, *, unique=False)

Bases: Object[VoiceState]

Source: Voice State Structure

guild_id: Source:

Source: guild_id

channel_id: Source:

Source: channel_id

user_id: Source:

Source: user_id

member: Source:

Source: member

session_id: Source:

Source: session_id

deaf: Source:

Source: deaf

mute: Source:

Source: mute

self_deaf: Source:

Source: self_deaf

self_mute: Source:

Source: self_mute

self_stream: Source:

Source: self_stream

self_video: Source:

Source: self_video

suppress: Source:

Source: suppress

request_to_speak_timestamp: Source:

Source: request_to_speak_timestamp

class aiocord.model.objects.VoiceRegion(data: _DataV, /, *, unique=False)

Bases: Object[VoiceRegion]

Source: Voice Region Structure

id: Source:

Source: id

name: Source:

Source: name

optimal: Source:

Source: optimal

deprecated: Source:

Source: deprecated

custom: Source:

Source: custom

class aiocord.model.objects.Webhook(data: _DataV, /, *, unique=False)

Bases: Object[Webhook]

Source: Webhook Structure

id: Source:

Source: id

type: Source:

Source: type

guild_id: Source:

Source: guild_id

channel_id: Source:

Source: channel_id

user: Source:

Source: user

name: Source:

Source: name

avatar: Source:

Source: avatar

token: Source:

Source: token

application_id: Source:

Source: application_id

source_guild: Source:

Source: source_guild

source_channel: Source:

Source: source_channel

url: Source:

Source: url

class aiocord.model.objects.Presence(data: _DataV, /, *, unique=False)

Bases: Object[Presence]

Source: Presence Update Presence Update Event Fields

user: Source:

Source: user

guild_id: Source:

Source: guild_id

status: Source:

Source: status

activities: Source:

Source: activities

client_status: Source:

Source: client_status

class aiocord.model.objects.ClientStatus(data: _DataV, /, *, unique=False)

Bases: Object[ClientStatus]

Source: https://discord.com/developers/docs</topics/gateway-events#client-status-object>

desktop: Source:

Source: desktop

mobile: Source:

Source: mobile

web: Source:

Source: web

class aiocord.model.objects.Activity(data: _DataV, /, *, unique=False)

Bases: Object[Activity]

Source: Activity Structure

name: Source:

Source: name

type: Source:

Source: type

url: Source:

Source: url

created_at: Source:

Source: created_at

timestamps: Source:

Source: timestamps

application_id: Source:

Source: application_id

details: Source:

Source: details

state: Source:

Source: state

emoji: Source:

Source: emoji

party: Source:

Source: party

assets: Source:

Source: assets

secrets: Source:

Source: secrets

instance: Source:

Source: instance

flags: Source:

Source: flags

buttons: Source:

Source: buttons

class aiocord.model.objects.ActivityTimestamps(data: _DataV, /, *, unique=False)

Bases: Object[ActivityTimestamps]

Source: Activity Timestamps

start: Source:

Source: start

end: Source:

Source: end

class aiocord.model.objects.ActivityParty(data: _DataV, /, *, unique=False)

Bases: Object[ActivityParty]

Source: Activity Party

id: Source:

Source: id

size: Source:

Source: size

class aiocord.model.objects.ActivityAssets(data: _DataV, /, *, unique=False)

Bases: Object[ActivityAssets]

Source: Activity Assets

large_image: Source:

Source: large_image

large_text: Source:

Source: large_text

small_image: Source:

Source: small_image

small_text: Source:

Source: small_text

class aiocord.model.objects.ActivitySecrets(data: _DataV, /, *, unique=False)

Bases: Object[ActivitySecrets]

Source: Activity Secrets

join: Source:

Source: join

spectate: Source:

Source: spectate

match: Source:

Source: match

class aiocord.model.objects.ActivityButton(data: _DataV, /, *, unique=False)

Bases: Object[ActivityButton]

Source: Activity Buttons

label: Source:

Source: label

url: Source:

Source: url

class aiocord.model.objects.Role(data: _DataV, /, *, unique=False)

Bases: Object[Role]

Source: Role Structure

id: Source:

Source: id

name: Source:

Source: name

color: Source:

Source: color

hoist: Source:

Source: hoist

icon: Source:

Source: icon

unicode_emoji: Source:

Source: unicode_emoji

position: Source:

Source: position

permissions: Source:

Source: permissions

managed: Source:

Source: managed

mentionable: Source:

Source: mentionable

tags: Source:

Source: tags

mention()

Get the mention.

icon_url(**kwargs)

Get the icon url.

class aiocord.model.objects.RoleTags(data: _DataV, /, *, unique=False)

Bases: Object[RoleTags]

Source: Role Tags Structure

bot_id: Source:

Source: bot_id

integration_id: Source:

Source: integration_id

premium_subscriber: Source:

Source: premium_subscriber

subscription_listing_id: Source:

Source: subscription_listing_id

available_for_purchase: Source:

Source: available_for_purchase

guild_connections: Source:

Source: guild_connections

class aiocord.model.objects.Team(data: _DataV, /, *, unique=False)

Bases: Object[Team]

Source: Data Models Team Object

icon: Source:

Source: icon

id: Source:

Source: id

members: Source:

Source: members

name: Source:

Source: name

owner_user_id: Source:

Source: owner_user_id

image_url(**kwargs)

Get the image url.

class aiocord.model.objects.TeamMember(data: _DataV, /, *, unique=False)

Bases: Object[TeamMember]

Source: Data Models Team Member Object

membership_state: Source:

Source: membership_state

permissions: Source:

Source: permissions

team_id: Source:

Source: team_id

user: Source:

Source: user

class aiocord.model.objects.SKU(data: _DataV, /, *, unique=False)

Bases: Object[SKU]

Source: SKU Structure

id: Source:

type: Source:

application_id: Source:

name: Source:

slug: Source:

flags: Source:

class aiocord.model.objects.Entitlement(data: _DataV, /, *, unique=False)

Bases: Object[Entitlement]

Source: Entitlement Structure

id: Source:

sku_id: Source:

application_id: Source:

user_id: Source:

deleted: Source:

starts_at: Source:

ends_at: Source:

guild_id: Source:

mentions

Message Formatting using basic types.

aiocord.model.mentions.user(user_id)

aiocord.model.mentions.channel(channel_id)

aiocord.model.mentions.role(role_id)

aiocord.model.mentions.command(command_name, command_id)

aiocord.model.mentions.emoji(emoji_name, emoji_id, animated=False)

aiocord.model.mentions.timestamp(value, style=None)

images

Image Formatting using basic types.

aiocord.model.images.emoji(emoji_id, /, **kwargs)

aiocord.model.images.guild_icon(guild_id, guild_icon, /, **kwargs)

aiocord.model.images.guild_splash(guild_id, guild_splash, /, **kwargs)

aiocord.model.images.guild_discovery_splash(guild_id, guild_discovery_splash, /, **kwargs)

aiocord.model.images.guild_banner(guild_id, guild_banner, /, **kwargs)

aiocord.model.images.user_banner(user_id, user_banner, /, **kwargs)

aiocord.model.images.default_user_avatar(user_discriminator, /, **kwargs)

aiocord.model.images.user_avatar(user_id, user_avatar, /, **kwargs)

aiocord.model.images.guild_member_avatar(guild_id, user_id, guild_member_avatar, /, **kwargs)

aiocord.model.images.application_icon(application_id, icon, /, **kwargs)

aiocord.model.images.application_cover(application_id, cover_image, /, **kwargs)

aiocord.model.images.application_asset(application_id, asset_id, /, **kwargs)

aiocord.model.images.achievement_icon(application_id, achievement_id, icon_hash, /, **kwargs)

aiocord.model.images.store_page_asset(application_id, asset_id, /, **kwargs)

aiocord.model.images.sticker_pack_banner(sticker_pack_banner_asset_id, /, **kwargs)

aiocord.model.images.team_icon(team_id, team_icon, /, **kwargs)

aiocord.model.images.sticker(sticker_id, /, **kwargs)

aiocord.model.images.role_icon(role_id, role_icon, /, **kwargs)

aiocord.model.images.guild_scheduled_event_cover(scheduled_event_id, scheduled_event_cover, /, **kwargs)

aiocord.model.images.guild_member_banner(guild_id, user_id, member_banner, /, **kwargs)