dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-05-25 21:12:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

more docs

Browse source
This commit is contained in:
hydrabolt 2015-09-27 20:26:53 +01:00
parent 9588f5cbf5
commit 66840c6a27
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/docs_client.rst
View file

@ -127,10 +127,20 @@ Functions
login(email, password, `callback`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`Parameters`:
Logs the client in to set it up. Use this after registering your event listeners to ensure they are called.
- **email** - A `String` which is the email you want to sign in with.
- **password** - A `String` which is the password you want to sign in with.
- **callback** - A `function` that can take the following parameters:
- **error** - null if there was no error, otherwise it is set.
- **token** - if successful, it is the received authorisation token.
- **token** - if successful, it is the received authorisation token.
logout(`callback`)
~~~~~~~~~~~~~~~~~~
Logs the client out if it is logged in. If successful, ``bot.state == 4``.
- **callback** - A `function` that can take the following parameters:
- **error** - null if there was no error, otherwise it is set.