aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-08-21 01:54:33 -0400
committerRapptz <[email protected]>2017-08-21 01:57:07 -0400
commit37b0fdb898a0f242f68d30abb6c58bd1a15a6524 (patch)
treebd752d8748bfb7aa4304b55183d8544f9d14886f /docs/api.rst
parentUse time.monotonic instead of time.time for heartbeat code. (diff)
downloaddiscord.py-37b0fdb898a0f242f68d30abb6c58bd1a15a6524.tar.xz
discord.py-37b0fdb898a0f242f68d30abb6c58bd1a15a6524.zip
Add webhook support.
Allows for usage of either `requests` and `aiohttp` when used in "Standalone" mode. Fixes #704
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst24
1 files changed, 23 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst
index c0816af0..cd163d80 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1692,6 +1692,29 @@ this goal, it must make use of a couple of data classes that aid in this goal.
.. this is currently missing the following keys: reason and application_id
I'm not sure how to about porting these
+Webhook Support
+------------------
+
+discord.py offers support for creating, editing, and executing webhooks through the :class:`Webhook` class.
+
+.. autoclass:: Webhook
+ :members:
+
+Adapters
+~~~~~~~~~
+
+Adapters allow you to change how the request should be handled. They all build on a single
+interface, :meth:`WebhookAdapter.request`.
+
+.. autoclass:: WebhookAdapter
+ :members:
+
+.. autoclass:: AsyncWebhookAdapter
+ :members:
+
+.. autoclass:: RequestsWebhookAdapter
+ :members:
+
.. _discord_api_abcs:
Abstract Base Classes
@@ -1986,7 +2009,6 @@ PermissionOverwrite
.. autoclass:: PermissionOverwrite
:members:
-
Exceptions
------------