From 66840c6a27e40f39ca16897f570e85af47954c87 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Sun, 27 Sep 2015 20:26:53 +0100 Subject: [PATCH] more docs --- docs/docs_client.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 3a900dd7a..376d6e964 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -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. \ No newline at end of file + - **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. \ No newline at end of file