From 8041fccb5c4f3d57f7a8c4b80e1e02dd8a1eb4aa Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Thu, 19 Nov 2015 18:48:05 +0000 Subject: [PATCH] more docs --- docs/docs_client.rst | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index c90c2bc2a..b6e4a1cbb 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -107,6 +107,19 @@ Sends a message to the specified channel. - **error** - error object if any occurred - **message** - the sent Message_ +sendFile(channel, attachment, name, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sends a file to the specified channel. + +- **channel** - a `Channel Resolvable`_ +- **attachment** - A ReadableStream, String or Buffer +- **name** - `String`, name of the file containing the extension +- **callback** - `function` taking the following: + + - **error** - error if any occurred + - **message** - the sent Message_ + reply(message, content, `options`, `callback`) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -148,4 +161,32 @@ Updates the content of a previously sent message - **callback** - `function` that takes the following parameters: - **error** - error object if any occurred - - **message** - the sent Message_ \ No newline at end of file + - **message** - the sent Message_ + +getChannelLogs(channel, `limit`, `options`, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Gets a list of previously sent messages in a channel. + +- **channel** - The Channel_ to get messages from +- **limit** - The maximum amount of messages to retrieve - defaults to 500. A `Number` +- **options** - An `object` containing either of the following: + + - **before** - A `Message Resolvable` - gets messages before this message. + - **after** - A `Message Resolvable` - gets messages after this message. +- **callback** - `function` taking the following: + + - **error** - error if any occurred + - **messages** - `array` of Message_ objects sent in channel + +getBans(server, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Gets a list of banned users in a server. + +- **server** - `Server Resolvable` - The server to get banned users of +- **callback** - `function` taking the following: + + - **error** - error if any occurred + - **users** - `array` of banned users in the server +