From 37b0fdb898a0f242f68d30abb6c58bd1a15a6524 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Mon, 21 Aug 2017 01:54:33 -0400 Subject: Add webhook support. Allows for usage of either `requests` and `aiohttp` when used in "Standalone" mode. Fixes #704 --- docs/api.rst | 24 +++++++++++++++++++++++- docs/conf.py | 1 + 2 files changed, 24 insertions(+), 1 deletion(-) (limited to 'docs') 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 ------------ diff --git a/docs/conf.py b/docs/conf.py index c29c8e94..caaa0687 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,6 +50,7 @@ extlinks = { rst_prolog = """ .. |coro| replace:: This function is a |corourl|_. +.. |maybecoro| replace:: This function *could be a* |corourl|_. .. |corourl| replace:: *coroutine* .. _corourl: https://docs.python.org/3/library/asyncio-task.html#coroutine """ -- cgit v1.2.3