From 6c77d99fbc6ae4010261faff79a98892a9a0121b Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Thu, 19 Nov 2015 18:28:13 +0000 Subject: [PATCH] Added some basic functions --- docs/docs_client.rst | 61 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 28ae3a100..73db7f759 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -46,4 +46,63 @@ 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 +A User_ object representing the logged in client's user. + +Functions +--------- + +.. note :: Any functions used here that take callbacks as an optional parameter can also be used as Promises_. Promises take the exact same parameters for each use case, except errors are moved to catch statements instead of then. For example, you can do: + +.. code-block:: js + + bot.login(email, password).then(success).catch(err); + + function success(token){ + + } + + function err(error){ + + } + + // OR use callbacks: + + bot.login(email, password, function(error, token){ + + }); + +login(email, password, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Logs the client in so it can begin initialising. Use this `after` registering your events to ensure they are called! + +- **email** - The e-mail used to sign in, `String`. +- **password** - The password used to sign in, `String`. +- **callback** - `function` that takes the following parameters: + + - **error** - An error if any occurred + - **token** - The token received after logging in, `String`. + +logout(`callback`) +~~~~~~~~~~~~~~~~~~ + +Logs the client out and closes the WebSocket connections. + +- **callback** - `function` that takes the following parameter: + + - **error** - An error if any occurred + +sendMessage(channel, content, `options`, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sends a message to the specified channel. + +- **channel** - a `Channel Resolvable`_ +- **content** - a `String Resolvable`_ - the message you want to send +- **options** - `object` containing: + + - **tts** - `Boolean`, should message be text-to-speech +- **callback** - `function` that takes the following parameters: + + - **error** - error object if any occurred + - **message** - the sent Message_ \ No newline at end of file