more docs

This commit is contained in:
hydrabolt
2015-11-19 18:48:05 +00:00
parent b7a54cb3e8
commit 8041fccb5c

View File

@@ -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_
- **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