From d7d170cab7588f2b02618ac0e965d4bf259616f0 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Sat, 5 Dec 2015 18:09:57 +0000 Subject: [PATCH 1/2] Finished server docs update --- docs/docs_server.rst | 74 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 64 insertions(+), 10 deletions(-) diff --git a/docs/docs_server.rst b/docs/docs_server.rst index 82383c88d..ea1df1c6e 100644 --- a/docs/docs_server.rst +++ b/docs/docs_server.rst @@ -65,6 +65,8 @@ The channel where AFK users are moved to, ServerChannel_ object. If one isn't se defaultChannel ~~~~~~~~~~~~~~ +**Aliases** `generalChannel, general` + The ``#general`` ServerChannel_ of the server. owner @@ -90,33 +92,85 @@ Returns an array of the roles affecting a user server-wide. leave() ~~~~~~~ -| **Shortcut of:** ``client.leaveServer(server)`` -| **Aliases:** `delete` -| **See:** client.leaveServer_ +| **Shortcut of** ``client.leaveServer(server)`` +| **Aliases** `delete` +| **See** client.leaveServer_ + +------ + | createInvite(`options`, `callback`) ~~~~~~~ -| **Shortcut of:** ``client.createInvite(server, options, callback)`` -| **See:** client.createInvite_ +| **Shortcut of** ``client.createInvite(server, options, callback)`` +| **See** client.createInvite_ | +------ + createRole(`data`, `callback`) ~~~~~~~ -| **Shortcut of:** ``client.createRole(server, data, callback)`` -| **See:** client.createRole_ +| **Shortcut of** ``client.createRole(server, data, callback)`` +| **See** client.createRole_ | +------ + createChannel(name, `type`, `callback`) ~~~~~~~ -| **Shortcut of:** ``client.createChannel(server, name, type, callback)`` -| **See:** client.createChannel_ +| **Shortcut of** ``client.createChannel(server, name, type, callback)`` +| **See** client.createChannel_ | +------ + +getBans(`callback`) +~~~~~~~~~~~~~~~~~~~ + +| **Shortcut of** ``client.getBans(server, callback)`` +| **See** client.getBans_ +| + +------ + +banMember(user, `length`, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| **Shortcut of** ``client.banMember(member, server, length, callback)`` +| **Aliases** `banUser, ban` +| **See** client.banMember_ +| + +------ + +unbanMember(user, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| **Shortcut of** ``client.unbanMember(member, server, callback)`` +| **Aliases** `unbanUser, unban` +| **See** client.unbanMember_ +| + +------ + +kickMember(user, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| **Shortcut of** ``client.kickMember(member, server, callback)`` +| **Aliases** `kickUser, kick` +| **See** client.kickMember_ +| + +------ + .. _client.leaveServer : ./docs_client.html#leaveserver-server-callback .. _client.createInvite : ./docs_client.html#createinvite-channel-options-callback .. _client.createRole : ./docs_client.html#createrole-server-data-callback -.. _client.createChannel : ./docs_client.html#createchannel-server-name-type-callback \ No newline at end of file +.. _client.createChannel : ./docs_client.html#createchannel-server-name-type-callback +.. _client.banMember : ./docs_client.html#banmember-user-server-length-callback +.. _client.unbanMember : ./docs_client.html#unbanmember-user-server-callback +.. _client.kickMember : ./docs_client.html#kickmember-user-server-callback +.. _client.getBans : ./docs_client.html#getbans-server-callback \ No newline at end of file From 1d8905d25adffcc4c89e9f2938f45398b89495a5 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Sat, 5 Dec 2015 18:17:01 +0000 Subject: [PATCH 2/2] Finalised server documentation I think --- docs/docs_server.rst | 19 +++++++++++++++++++ src/Structures/Server.js | 4 ++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/docs_server.rst b/docs/docs_server.rst index ea1df1c6e..1903f9554 100644 --- a/docs/docs_server.rst +++ b/docs/docs_server.rst @@ -89,6 +89,25 @@ rolesOfUser(user) Returns an array of the roles affecting a user server-wide. +------ + +detailsOfUser(user) +~~~~~~~~~~~~~~~~~~~ + +**Aliases** `detailsOf` + +Returns an object containing metadata of a user within the server, containing a structure similar to the following: + +.. code-block:: js + + { + joinedAt : 1449339323747, + mute : false, + deaf : false + } + +---------- + leave() ~~~~~~~ diff --git a/src/Structures/Server.js b/src/Structures/Server.js index 9ceb47124..df8157d02 100644 --- a/src/Structures/Server.js +++ b/src/Structures/Server.js @@ -71,7 +71,7 @@ export default class Server extends Equality { } } - details(user) { + detailsOf(user) { user = this.client.internal.resolver.resolveUser(user); if (user) { return this.memberMap[user.id]; @@ -80,7 +80,7 @@ export default class Server extends Equality { } } - detailsOf(user) { + detailsOfUser(user) { return this.details(user); }