aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-01-24 21:55:23 -0500
committerRapptz <[email protected]>2017-01-24 22:00:27 -0500
commit02f30f21c4a9f4dfb3264de74590c3327878cbac (patch)
treeb91b543734dc8d8033c34455811d6d430bc56eea /docs/api.rst
parentAdd option to disable auto member chunking. (diff)
downloaddiscord.py-02f30f21c4a9f4dfb3264de74590c3327878cbac.tar.xz
discord.py-02f30f21c4a9f4dfb3264de74590c3327878cbac.zip
Implement User.profile coroutine to get a user's profile.
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index b31fa280..87d31759 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -481,6 +481,35 @@ Application Info
The owner of the application. This is a :class:`User` instance
with the owner's information at the time of the call.
+Profile
+---------
+
+.. class:: Profile
+
+ A namedtuple representing a user's Discord public profile.
+
+ .. attribute:: user
+
+ The :class:`User` the profile belongs to.
+ .. attribute:: premium
+
+ A boolean indicating if the user has premium (i.e. Discord Nitro).
+ .. attribute:: premium_since
+
+ A naive UTC datetime indicating how long the user has been premium since.
+ This could be ``None`` if not applicable.
+ .. attribute:: mutual_guilds
+
+ A list of :class:`Guild` that the :class:`ClientUser` shares with this
+ user.
+ .. 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"}
+
.. _discord-api-enums:
Enumerations