From 1d0967dbe8959fedab6b4e12ac303cfa3a5d5138 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Thu, 19 Nov 2015 18:16:44 +0000 Subject: [PATCH] Added attributes --- docs/docs_client.rst | 47 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 172da247c..28ae3a100 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -1,4 +1,49 @@ .. include:: ./vars.rst Client -====== \ No newline at end of file +====== + +This page contains documentation on the `Discord.Client` class. This should be used when you want to start creating things with the API. + +Attributes +---------- + +users +~~~~~ + +A Cache_ of User_ objects that the client has cached. + +channels +~~~~~~~~ + +A Cache_ of ServerChannel_ objects that the client has cached. + +privateChannels +~~~~~~~~~~~~~~~ + +A Cache_ of PMChannel_ objects that the client has cached. These are all the Private/Direct Chats the client is in. + +servers +~~~~~~~ + +A Cache_ of Server_ objects that the client has cached. + +voiceConnection +~~~~~~~~~~~~~~~ + +A VoiceConnection_ object that is the current voice connection (if any). + +readyTime +~~~~~~~~~ + +A `Number` unix timestamp dating to when the Client emitted `ready`. + +uptime +~~~~~~ + +A `Number` in milliseconds representing how long the Client has been ready for. + +user +~~~~ + +A User_ object representing the logged in client's user. \ No newline at end of file