From 1d8905d25adffcc4c89e9f2938f45398b89495a5 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Sat, 5 Dec 2015 18:17:01 +0000 Subject: [PATCH] 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 ea1df1c6..1903f955 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 9ceb4712..df8157d0 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); }