aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-06-10 22:28:15 -0400
committerRapptz <[email protected]>2016-06-10 22:28:15 -0400
commita175c86aa1587c43303e8a06e2078c05a7892938 (patch)
tree4dea3eaf0cd5775ba365def9a6721d3845cce88f /docs
parentHandle voice websocket closure if it's a successful close. (diff)
downloaddiscord.py-a175c86aa1587c43303e8a06e2078c05a7892938.tar.xz
discord.py-a175c86aa1587c43303e8a06e2078c05a7892938.zip
Add Client.application_info to retrieve the current app info.
Fixes #241.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 4700a3ba..21ffabaa 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -31,7 +31,6 @@ There are two main ways to query version information about the library.
A string representation of the version. e.g. ``'0.10.0-alpha0'``.
-
Client
-------
@@ -345,6 +344,31 @@ Utility Functions
.. autofunction:: discord.utils.oauth_url
+Application Info
+------------------
+
+.. class:: AppInfo
+
+ A namedtuple representing the bot's application info.
+
+ .. attribute:: id
+
+ The application's ``client_id``.
+ .. attribute:: name
+
+ The application's name.
+ .. attribute:: description
+
+ The application's description
+ .. attribute:: icon
+
+ The application's icon hash if it exists, ``None`` otherwise.
+ .. attribute:: icon_url
+
+ A property that retrieves the application's icon URL if it exists.
+
+ If it doesn't exist an empty string is returned.
+
.. _discord-api-enums:
Enumerations