dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-05-24 20:42:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated, testing something

Browse source
This commit is contained in:
hydrabolt 2015-09-27 19:19:15 +01:00
parent ffa415afdf
commit d581bf4d63
1 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/docs_client.rst
View file

@ -1,6 +1,8 @@
Client Documentation
====================
This page contains documentation on the `Discord.Client` class. This should be used when you want to start creating things with the API.
Attributes
----------
@ -17,7 +19,11 @@ An `Object` containing a configuration for the Client. Currently can only be con
token
~~~~~
A `String` that is the token received after logging in. It is used to authorise the Client when joining WebSockets or making HTTP requests.
A `String` that is the token received after logging in. It is used to authorise the Client when joining WebSockets or making HTTP requests. Example token:
.. code-block:: js
ODAzTOc4MTA2BjQ2MjY4ODg.COmrCA.fEtD_Tc0JU6iZJU_11coEWBOQHE
state
~~~~~
@ -29,5 +35,17 @@ An `Integer` representing what state of connection the Client is in.
- **3** is ready, meaning the Client is ready to begin listening.
- **4** is disconnected, meaning the Client was disconnected due to any reason.
.. code-block:: js
if( bot.state === 3 ) // ready to go
user
~~~~
A `User`_ object representing the user of the signed in client.
Functions
---------
---------
.. _User : #user