From ae635685da77db9011205bba7bde448fa25b80a1 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Thu, 19 Nov 2015 20:58:24 +0000 Subject: [PATCH] Updated docs to include abala's additions --- docs/docs_client.rst | 36 +++++++++++++++++++++++++++++++++ lib/Client/Client.js | 2 +- lib/Client/InternalClient.js | 2 +- lib/Client/Resolver/Resolver.js | 2 +- lib/Structures/Message.js | 2 +- lib/Structures/PMChannel.js | 2 +- lib/Structures/ServerChannel.js | 2 +- lib/Structures/TextChannel.js | 2 +- lib/Util/Cache.js | 2 +- 9 files changed, 44 insertions(+), 8 deletions(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 5b2148d6c..578427b75 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -497,6 +497,42 @@ Overwrites the permissions of a role or a user in a channel "sendMessages" : false, "attachFiles" : true } + +updateRole(role, data, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Updates a role in a server. + +- **role** - a Role_ +- **data** - an `object` taking the structure shown below +- **callback** - a `function` taking the following: + + - **error** - error if any occurred + - **role** - the updated Role_ + +.. code-block:: js + + // structure of data parameter (all attrs optional): + + { + color : 0xFF0000, + hoist : false, + name : "A New Role!", + permissions : [ + // see the constants documentation for full permissions + "attachFiles", "sendMessages" + ] + } + +deleteInvite(invite, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Deletes an invite + +- **invite** - An `Invite ID Resolvable`_ +- **callback** - a `function` taking the following: + + - **error** - error if any occurred Events ------ diff --git a/lib/Client/Client.js b/lib/Client/Client.js index d973cc92e..e9ac111bb 100644 --- a/lib/Client/Client.js +++ b/lib/Client/Client.js @@ -849,4 +849,4 @@ var Client = (function (_EventEmitter) { return Client; })(EventEmitter); -module.exports = Client; +module.exports = Client; \ No newline at end of file diff --git a/lib/Client/InternalClient.js b/lib/Client/InternalClient.js index 43410ee25..6f3193001 100644 --- a/lib/Client/InternalClient.js +++ b/lib/Client/InternalClient.js @@ -1590,4 +1590,4 @@ var InternalClient = (function () { return InternalClient; })(); -module.exports = InternalClient; +module.exports = InternalClient; \ No newline at end of file diff --git a/lib/Client/Resolver/Resolver.js b/lib/Client/Resolver/Resolver.js index ee5bbc23a..8617f1c48 100644 --- a/lib/Client/Resolver/Resolver.js +++ b/lib/Client/Resolver/Resolver.js @@ -207,4 +207,4 @@ var Resolver = (function () { return Resolver; })(); -module.exports = Resolver; +module.exports = Resolver; \ No newline at end of file diff --git a/lib/Structures/Message.js b/lib/Structures/Message.js index 53ea5116b..55a76fdb1 100644 --- a/lib/Structures/Message.js +++ b/lib/Structures/Message.js @@ -69,4 +69,4 @@ var Message = (function () { return Message; })(); -module.exports = Message; +module.exports = Message; \ No newline at end of file diff --git a/lib/Structures/PMChannel.js b/lib/Structures/PMChannel.js index 5b10a68f3..837c4a378 100644 --- a/lib/Structures/PMChannel.js +++ b/lib/Structures/PMChannel.js @@ -52,4 +52,4 @@ var PMChannel = (function (_Equality) { return PMChannel; })(Equality); -module.exports = PMChannel; +module.exports = PMChannel; \ No newline at end of file diff --git a/lib/Structures/ServerChannel.js b/lib/Structures/ServerChannel.js index 1e0fdae96..0349d33f9 100644 --- a/lib/Structures/ServerChannel.js +++ b/lib/Structures/ServerChannel.js @@ -114,4 +114,4 @@ var ServerChannel = (function (_Channel) { return ServerChannel; })(Channel); -module.exports = ServerChannel; +module.exports = ServerChannel; \ No newline at end of file diff --git a/lib/Structures/TextChannel.js b/lib/Structures/TextChannel.js index 08ba7bf28..6e7a8a664 100644 --- a/lib/Structures/TextChannel.js +++ b/lib/Structures/TextChannel.js @@ -57,4 +57,4 @@ var TextChannel = (function (_ServerChannel) { return TextChannel; })(ServerChannel); -module.exports = TextChannel; +module.exports = TextChannel; \ No newline at end of file diff --git a/lib/Util/Cache.js b/lib/Util/Cache.js index 29c0002da..3bdf3477d 100644 --- a/lib/Util/Cache.js +++ b/lib/Util/Cache.js @@ -99,4 +99,4 @@ var Cache = (function (_Array) { return Cache; })(Array); -module.exports = Cache; +module.exports = Cache; \ No newline at end of file