diff options
| author | NCPlayz <[email protected]> | 2019-04-15 17:41:27 +0100 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2019-05-09 06:11:19 -0400 |
| commit | 25d933748182492484fd9a9ce7bef147b2c86c2e (patch) | |
| tree | 2ec25fdc97ce5f0272cd2d591d6680e3ffa77709 /docs | |
| parent | Add cached_message to on_raw_message_edit event (diff) | |
| download | discord.py-25d933748182492484fd9a9ce7bef147b2c86c2e.tar.xz discord.py-25d933748182492484fd9a9ce7bef147b2c86c2e.zip | |
Document remaining public enums.
- UserContentFilter
- FriendFlags
- PremiumType
- Theme
UserFlags is not documented as though it is only used internally.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 127 |
1 files changed, 110 insertions, 17 deletions
diff --git a/docs/api.rst b/docs/api.rst index 78a96f45..bcf0e25d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -943,23 +943,6 @@ All enumerations are subclasses of `enum`_. a presence a la :meth:`Client.change_presence`. When you receive a user's presence this will be :attr:`offline` instead. -.. class:: RelationshipType - - Specifies the type of :class:`Relationship` - - .. attribute:: friend - - You are friends with this user. - .. attribute:: blocked - - You have blocked this user. - .. attribute:: incoming_request - - The user has sent you a friend request. - .. attribute:: outgoing_request - - You have sent a friend request to this user. - .. class:: AuditLogAction @@ -1369,6 +1352,116 @@ All enumerations are subclasses of `enum`_. The action is the update of something. +.. class:: RelationshipType + + Specifies the type of :class:`Relationship`. + + .. note:: + + This only applies to users, *not* bots. + + .. attribute:: friend + + You are friends with this user. + + .. attribute:: blocked + + You have blocked this user. + + .. attribute:: incoming_request + + The user has sent you a friend request. + + .. attribute:: outgoing_request + + You have sent a friend request to this user. + + +.. class:: UserContentFilter + + Represents the options found in ``Settings > Privacy & Safety > Safe Direct Messaging`` + in the Discord client. + + .. note:: + + This only applies to users, *not* bots. + + .. attribute:: all_messages + + Scan all direct messages from everyone. + + .. attribute:: friends + + Scan all direct messages that aren't from friends. + + .. attribute:: disabled + + Don't scan any direct messages. + + +.. class:: FriendFlags + + Represents the options found in ``Settings > Privacy & Safety > Who Can Add You As A Friend`` + in the Discord client. + + .. note:: + + This only applies to users, *not* bots. + + .. attribute:: noone + + This allows no-one to add you as a friend. + + .. attribute:: mutual_guilds + + This allows guild members to add you as a friend. + + .. attribute:: mutual_friends + + This allows friends of friends to add you as a friend. + + .. attribute:: guild_and_friends + + This is a superset of :attr:`mutual_guilds` and :attr:`mutual_friends`. + + .. attribute:: everyone + + This allows everyone to add you as a friend. + + +.. class:: PremiumType + + Represents the user's Discord Nitro subscription type. + + .. note:: + + This only applies to users, *not* bots. + + .. attribute:: nitro + + Represents the Discord Nitro with Nitro-exclusive games. + + .. attribute:: nitro_classic + + Represents the Discord Nitro with no Nitro-exclusive games. + + +.. class:: Theme + + Represents the theme synced across all Discord clients. + + .. note:: + + This only applies to users, *not* bots. + + .. attribute:: light + + Represents the Light theme on Discord. + + .. attribute:: dark + + Represents the Dark theme on Discord. + Async Iterator ---------------- |