diff options
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 204 |
1 files changed, 201 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst index 6a1b6614..1e518bda 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -30,45 +30,108 @@ There are two main ways to query version information about the library. For guar A string representation of the version. e.g. ``'1.0.0rc1'``. This is based off of :pep:`440`. +Clients +-------- + Client -------- +~~~~~~~ + +.. attributetable:: Client .. autoclass:: Client :members: +AutoShardedClient +~~~~~~~~~~~~~~~~~~ + +.. attributetable:: AutoShardedClient + .. autoclass:: AutoShardedClient :members: +Application Info +------------------ + +AppInfo +~~~~~~~~ + +.. attributetable:: AppInfo + .. autoclass:: AppInfo() :members: +Team +~~~~~ + +.. attributetable:: Team + .. autoclass:: Team() :members: +TeamMember +~~~~~~~~~~~ + +.. attributetable:: TeamMember + .. autoclass:: TeamMember() :members: -Voice ------- +Voice Related +--------------- + +VoiceClient +~~~~~~~~~~~~ + +.. attributetable:: VoiceClient .. autoclass:: VoiceClient() :members: +AudioSource +~~~~~~~~~~~~ + +.. attributetable:: AudioSource + .. autoclass:: AudioSource :members: +PCMAudio +~~~~~~~~~ + +.. attributetable:: PCMAudio + .. autoclass:: PCMAudio :members: +FFmpegAudio +~~~~~~~~~~~~ + +.. attributetable:: FFmpegAudio + .. autoclass:: FFmpegAudio :members: +FFmpegPCMAudio +~~~~~~~~~~~~~~~ + +.. attributetable:: FFmpegPCMAudio + .. autoclass:: FFmpegPCMAudio :members: +FFmpegOpusAudio +~~~~~~~~~~~~~~~~ + +.. attributetable:: FFmpegOpusAudio + .. autoclass:: FFmpegOpusAudio :members: +PCMVolumeTransformer +~~~~~~~~~~~~~~~~~~~~~ + +.. attributetable:: PCMVolumeTransformer + .. autoclass:: PCMVolumeTransformer :members: @@ -1901,9 +1964,19 @@ Working with :meth:`Guild.audit_logs` is a complicated process with a lot of mac involved. The library attempts to make it easy to use and friendly. In order to accomplish this goal, it must make use of a couple of data classes that aid in this goal. +AuditLogEntry +~~~~~~~~~~~~~~~ + +.. attributetable:: AuditLogEntry + .. autoclass:: AuditLogEntry :members: +AuditLogChanges +~~~~~~~~~~~~~~~~~ + +.. attributetable:: AuditLogChanges + .. class:: AuditLogChanges An audit log change set. @@ -1948,6 +2021,11 @@ this goal, it must make use of a couple of data classes that aid in this goal. | ``None`` | No attributes are set. | +----------------------------------------+--------------------------------------------------+ +AuditLogDiff +~~~~~~~~~~~~~ + +.. attributetable:: AuditLogDiff + .. class:: AuditLogDiff Represents an audit log "change" object. A change object has dynamic @@ -2213,6 +2291,8 @@ Webhook Support discord.py offers support for creating, editing, and executing webhooks through the :class:`Webhook` class. +.. attributetable:: Webhook + .. autoclass:: Webhook :members: @@ -2244,18 +2324,43 @@ They are mainly there for usage with :func:`py:isinstance` and :func:`py:issubcl This library has a module related to abstract base classes, some of which are actually from the :doc:`abc <py:library/abc>` standard module, others which are not. +Snowflake +~~~~~~~~~~ + +.. attributetable:: discord.abc.Snowflake + .. autoclass:: discord.abc.Snowflake :members: +User +~~~~~ + +.. attributetable:: discord.abc.User + .. autoclass:: discord.abc.User :members: +PrivateChannel +~~~~~~~~~~~~~~~ + +.. attributetable:: discord.abc.PrivateChannel + .. autoclass:: discord.abc.PrivateChannel :members: +GuildChannel +~~~~~~~~~~~~~ + +.. attributetable:: discord.abc.GuildChannel + .. autoclass:: discord.abc.GuildChannel :members: +Messageable +~~~~~~~~~~~~ + +.. attributetable:: discord.abc.Messageable + .. autoclass:: discord.abc.Messageable :members: :exclude-members: history, typing @@ -2266,6 +2371,11 @@ module, others which are not. .. automethod:: discord.abc.Messageable.typing :async-with: +Connectable +~~~~~~~~~~~~ + +.. attributetable:: discord.abc.Connectable + .. autoclass:: discord.abc.Connectable .. _discord_api_models: @@ -2298,6 +2408,8 @@ the user of the library. ClientUser ~~~~~~~~~~~~ +.. attributetable:: ClientUser + .. autoclass:: ClientUser() :members: :inherited-members: @@ -2305,12 +2417,16 @@ ClientUser Relationship ~~~~~~~~~~~~~~ +.. attributetable:: Relationship + .. autoclass:: Relationship() :members: User ~~~~~ +.. attributetable:: User + .. autoclass:: User() :members: :inherited-members: @@ -2325,24 +2441,32 @@ User Attachment ~~~~~~~~~~~ +.. attributetable:: Attachment + .. autoclass:: Attachment() :members: Asset ~~~~~ +.. attributetable:: Asset + .. autoclass:: Asset() :members: Message ~~~~~~~ +.. attributetable:: Message + .. autoclass:: Message() :members: Reaction ~~~~~~~~~ +.. attributetable:: Reaction + .. autoclass:: Reaction() :members: :exclude-members: users @@ -2353,18 +2477,24 @@ Reaction CallMessage ~~~~~~~~~~~~ +.. attributetable:: CallMessage + .. autoclass:: CallMessage() :members: GroupCall ~~~~~~~~~~ +.. attributetable:: GroupCall + .. autoclass:: GroupCall() :members: Guild ~~~~~~ +.. attributetable:: Guild + .. autoclass:: Guild() :members: :exclude-members: audit_logs @@ -2375,6 +2505,8 @@ Guild Member ~~~~~~ +.. attributetable:: Member + .. autoclass:: Member() :members: :inherited-members: @@ -2389,36 +2521,48 @@ Member Spotify ~~~~~~~~ +.. attributetable:: Spotify + .. autoclass:: Spotify() :members: VoiceState ~~~~~~~~~~~ +.. attributetable:: VoiceState + .. autoclass:: VoiceState() :members: Emoji ~~~~~ +.. attributetable:: Emoji + .. autoclass:: Emoji() :members: PartialEmoji ~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: PartialEmoji + .. autoclass:: PartialEmoji() :members: Role ~~~~~ +.. attributetable:: Role + .. autoclass:: Role() :members: TextChannel ~~~~~~~~~~~~ +.. attributetable:: TextChannel + .. autoclass:: TextChannel() :members: :inherited-members: @@ -2433,6 +2577,8 @@ TextChannel VoiceChannel ~~~~~~~~~~~~~ +.. attributetable:: VoiceChannel + .. autoclass:: VoiceChannel() :members: :inherited-members: @@ -2440,6 +2586,8 @@ VoiceChannel CategoryChannel ~~~~~~~~~~~~~~~~~ +.. attributetable:: CategoryChannel + .. autoclass:: CategoryChannel() :members: :inherited-members: @@ -2447,6 +2595,8 @@ CategoryChannel DMChannel ~~~~~~~~~ +.. attributetable:: DMChannel + .. autoclass:: DMChannel() :members: :inherited-members: @@ -2461,6 +2611,8 @@ DMChannel GroupChannel ~~~~~~~~~~~~ +.. attributetable:: GroupChannel + .. autoclass:: GroupChannel() :members: :inherited-members: @@ -2475,30 +2627,40 @@ GroupChannel PartialInviteGuild ~~~~~~~~~~~~~~~~~~~ +.. attributetable:: PartialInviteGuild + .. autoclass:: PartialInviteGuild() :members: PartialInviteChannel ~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: PartialInviteChannel + .. autoclass:: PartialInviteChannel() :members: Invite ~~~~~~~ +.. attributetable:: Invite + .. autoclass:: Invite() :members: WidgetChannel ~~~~~~~~~~~~~~~ +.. attributetable:: WidgetChannel + .. autoclass:: WidgetChannel() :members: WidgetMember ~~~~~~~~~~~~~ +.. attributetable:: WidgetMember + .. autoclass:: WidgetMember() :members: :inherited-members: @@ -2506,42 +2668,56 @@ WidgetMember Widget ~~~~~~~ +.. attributetable:: Widget + .. autoclass:: Widget() :members: RawMessageDeleteEvent ~~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawMessageDeleteEvent + .. autoclass:: RawMessageDeleteEvent() :members: RawBulkMessageDeleteEvent ~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawBulkMessageDeleteEvent + .. autoclass:: RawBulkMessageDeleteEvent() :members: RawMessageUpdateEvent ~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawMessageUpdateEvent + .. autoclass:: RawMessageUpdateEvent() :members: RawReactionActionEvent ~~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawReactionActionEvent + .. autoclass:: RawReactionActionEvent() :members: RawReactionClearEvent ~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawReactionClearEvent + .. autoclass:: RawReactionClearEvent() :members: RawReactionClearEmojiEvent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: RawReactionClearEmojiEvent + .. autoclass:: RawReactionClearEmojiEvent() :members: @@ -2572,66 +2748,88 @@ Object Embed ~~~~~~ +.. attributetable:: Embed + .. autoclass:: Embed :members: AllowedMentions ~~~~~~~~~~~~~~~~~ +.. attributetable:: AllowedMentions + .. autoclass:: AllowedMentions :members: File ~~~~~ +.. attributetable:: File + .. autoclass:: File :members: Colour ~~~~~~ +.. attributetable:: Colour + .. autoclass:: Colour :members: BaseActivity ~~~~~~~~~~~~~~ +.. attributetable:: BaseActivity + .. autoclass:: BaseActivity :members: Activity ~~~~~~~~~ +.. attributetable:: Activity + .. autoclass:: Activity :members: Game ~~~~~ +.. attributetable:: Game + .. autoclass:: Game :members: Streaming ~~~~~~~~~~~ +.. attributetable:: Streaming + .. autoclass:: Streaming :members: CustomActivity ~~~~~~~~~~~~~~~ +.. attributetable:: CustomActivity + .. autoclass:: CustomActivity :members: Permissions ~~~~~~~~~~~~ +.. attributetable:: Permissions + .. autoclass:: Permissions :members: PermissionOverwrite ~~~~~~~~~~~~~~~~~~~~ +.. attributetable:: PermissionOverwrite + .. autoclass:: PermissionOverwrite :members: |