Finalised server documentation

I think
This commit is contained in:
Amish Shah
2015-12-05 18:17:01 +00:00
parent d7d170cab7
commit 1d8905d25a
2 changed files with 21 additions and 2 deletions

View File

@@ -89,6 +89,25 @@ rolesOfUser(user)
Returns an array of the roles affecting a user server-wide. 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() leave()
~~~~~~~ ~~~~~~~

View File

@@ -71,7 +71,7 @@ export default class Server extends Equality {
} }
} }
details(user) { detailsOf(user) {
user = this.client.internal.resolver.resolveUser(user); user = this.client.internal.resolver.resolveUser(user);
if (user) { if (user) {
return this.memberMap[user.id]; return this.memberMap[user.id];
@@ -80,7 +80,7 @@ export default class Server extends Equality {
} }
} }
detailsOf(user) { detailsOfUser(user) {
return this.details(user); return this.details(user);
} }