aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNadir Chowdhury <[email protected]>2020-06-28 19:50:43 +0100
committerGitHub <[email protected]>2020-06-28 14:50:43 -0400
commita64006ee9bf32b5a8e353db7399c9ff868afcb3d (patch)
tree8056865d84b50674a00e4200ae21a8ea38274d5d /docs
parentAdd support for Discord templates (diff)
downloaddiscord.py-a64006ee9bf32b5a8e353db7399c9ff868afcb3d.tar.xz
discord.py-a64006ee9bf32b5a8e353db7399c9ff868afcb3d.zip
Add support for integrations
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst31
1 files changed, 30 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst
index a9a3a468..8b4439d2 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -480,6 +480,8 @@ to handle it, which defaults to print a traceback and ignoring the exception.
.. function:: on_guild_integrations_update(guild)
+ .. versionadded:: 1.4
+
Called whenever an integration is created, modified, or removed from a guild.
:param guild: The guild that had its integrations updated.
@@ -1670,7 +1672,6 @@ of :class:`enum.Enum`.
The action is the update of something.
-
.. class:: RelationshipType
Specifies the type of :class:`Relationship`.
@@ -1810,6 +1811,24 @@ of :class:`enum.Enum`.
Represents a webhook that is internally managed by Discord, used for following channels.
+.. class:: ExpireBehaviour
+
+ Represents the behaviour the :class:`Integration` should perform
+ when a user's subscription has finished.
+
+ There is an alias for this called ``ExpireBehavior``.
+
+ .. versionadded:: 1.4
+
+ .. attribute:: remove_role
+
+ This will remove the :attr:`Integration.role` from the user
+ when their subscription is finished.
+
+ .. attribute:: kick
+
+ This will kick the user when their subscription is finished.
+
.. class:: DefaultAvatar
Represents the default avatar of a Discord :class:`User`
@@ -1838,6 +1857,7 @@ of :class:`enum.Enum`.
Represents the default avatar with the color red.
See also :attr:`Colour.red`
+
Async Iterator
----------------
@@ -2507,6 +2527,15 @@ Guild
.. automethod:: audit_logs
:async-for:
+Integration
+~~~~~~~~~~~~
+
+.. autoclass:: Integration()
+ :members:
+
+.. autoclass:: IntegrationAccount()
+ :members:
+
Member
~~~~~~