aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2021-04-04 10:09:25 -0400
committerRapptz <[email protected]>2021-04-04 10:15:30 -0400
commit54288879e28cc63eefce33311ec393a4eed476c4 (patch)
tree5bada5e0d4f1c997773d7216d14b3338ac76f1fa /docs
parentRemove asyncio.Task subclass in preference to task names (diff)
downloaddiscord.py-54288879e28cc63eefce33311ec393a4eed476c4.tar.xz
discord.py-54288879e28cc63eefce33311ec393a4eed476c4.zip
Remove userbot functionality
This has a lot of legacy and cruft so there may be some stuff I've missed but this first pass is enough to get a clear separation.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst235
1 files changed, 0 insertions, 235 deletions
diff --git a/docs/api.rst b/docs/api.rst
index f5bd8075..4a19c2c7 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -897,29 +897,6 @@ to handle it, which defaults to print a traceback and ignoring the exception.
:param user: The user that joined or left.
:type user: :class:`User`
-.. function:: on_relationship_add(relationship)
- on_relationship_remove(relationship)
-
- Called when a :class:`Relationship` is added or removed from the
- :class:`ClientUser`.
-
- .. deprecated:: 1.7
-
- :param relationship: The relationship that was added or removed.
- :type relationship: :class:`Relationship`
-
-.. function:: on_relationship_update(before, after)
-
- Called when a :class:`Relationship` is updated, e.g. when you
- block a friend or a friendship is accepted.
-
- .. deprecated:: 1.7
-
- :param before: The previous relationship status.
- :type before: :class:`Relationship`
- :param after: The updated relationship status.
- :type after: :class:`Relationship`
-
.. _discord-api-utils:
Utility Functions
@@ -945,97 +922,6 @@ Utility Functions
.. autofunction:: discord.utils.sleep_until
-Profile
----------
-
-.. class:: Profile
-
- A namedtuple representing a user's Discord public profile.
-
- .. deprecated:: 1.7
-
- .. attribute:: user
-
- The :class:`User` the profile belongs to.
-
- :type: :class:`User`
- .. attribute:: premium
-
- A boolean indicating if the user has premium (i.e. Discord Nitro).
-
- :type: :class:`bool`
- .. attribute:: nitro
-
- An alias for :attr:`premium`.
- .. attribute:: premium_since
-
- A naive UTC datetime indicating how long the user has been premium since.
- This could be ``None`` if not applicable.
-
- :type: :class:`datetime.datetime`
- .. attribute:: staff
-
- A boolean indicating if the user is Discord Staff.
-
- :type: :class:`bool`
- .. attribute:: partner
-
- A boolean indicating if the user is a Discord Partner.
-
- :type: :class:`bool`
- .. attribute:: bug_hunter
-
- A boolean indicating if the user is a Bug Hunter.
-
- :type: :class:`bool`
- .. attribute:: early_supporter
-
- A boolean indicating if the user has had premium before 10 October, 2018.
-
- :type: :class:`bool`
- .. attribute:: hypesquad
-
- A boolean indicating if the user is in Discord HypeSquad.
-
- :type: :class:`bool`
- .. attribute:: hypesquad_houses
-
- A list of :class:`HypeSquadHouse` that the user is in.
-
- :type: List[:class:`HypeSquadHouse`]
- .. attribute:: team_user
-
- A boolean indicating if the user is in part of a team.
-
- .. versionadded:: 1.3
-
- :type: :class:`bool`
-
- .. attribute:: system
-
- A boolean indicating if the user is officially part of the Discord urgent message system.
-
- .. versionadded:: 1.3
-
- :type: :class:`bool`
-
- .. attribute:: mutual_guilds
-
- A list of :class:`Guild` that the :class:`ClientUser` shares with this
- user.
-
- :type: List[:class:`Guild`]
-
- .. attribute:: connected_accounts
-
- A list of dict objects indicating the accounts the user has connected.
-
- An example entry can be seen below: ::
-
- {"type": "twitch", "id": "92473777", "name": "discordapp"}
-
- :type: List[Dict[:class:`str`, :class:`str`]]
-
.. _discord-api-enums:
Enumerations
@@ -1940,127 +1826,6 @@ of :class:`enum.Enum`.
The action is the update of something.
-.. class:: RelationshipType
-
- Specifies the type of :class:`Relationship`.
-
- .. deprecated:: 1.7
-
- .. 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.
-
- .. deprecated:: 1.7
-
- .. 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.
-
- .. deprecated:: 1.7
-
- .. 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.
-
- .. deprecated:: 1.7
-
- .. 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.
-
- .. deprecated:: 1.7
-
- .. note::
-
- This only applies to users, *not* bots.
-
- .. attribute:: light
-
- Represents the Light theme on Discord.
-
- .. attribute:: dark
-
- Represents the Dark theme on Discord.
-
-
.. class:: TeamMembershipState
Represents the membership state of a team member retrieved through :func:`Bot.application_info`.