Finished server docs update

This commit is contained in:
Amish Shah
2015-12-05 18:09:57 +00:00
parent a89938ed01
commit d7d170cab7

View File

@@ -65,6 +65,8 @@ The channel where AFK users are moved to, ServerChannel_ object. If one isn't se
defaultChannel defaultChannel
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
**Aliases** `generalChannel, general`
The ``#general`` ServerChannel_ of the server. The ``#general`` ServerChannel_ of the server.
owner owner
@@ -90,33 +92,85 @@ Returns an array of the roles affecting a user server-wide.
leave() leave()
~~~~~~~ ~~~~~~~
| **Shortcut of:** ``client.leaveServer(server)`` | **Shortcut of** ``client.leaveServer(server)``
| **Aliases:** `delete` | **Aliases** `delete`
| **See:** client.leaveServer_ | **See** client.leaveServer_
------
| |
createInvite(`options`, `callback`) createInvite(`options`, `callback`)
~~~~~~~ ~~~~~~~
| **Shortcut of:** ``client.createInvite(server, options, callback)`` | **Shortcut of** ``client.createInvite(server, options, callback)``
| **See:** client.createInvite_ | **See** client.createInvite_
| |
------
createRole(`data`, `callback`) createRole(`data`, `callback`)
~~~~~~~ ~~~~~~~
| **Shortcut of:** ``client.createRole(server, data, callback)`` | **Shortcut of** ``client.createRole(server, data, callback)``
| **See:** client.createRole_ | **See** client.createRole_
| |
------
createChannel(name, `type`, `callback`) createChannel(name, `type`, `callback`)
~~~~~~~ ~~~~~~~
| **Shortcut of:** ``client.createChannel(server, name, type, callback)`` | **Shortcut of** ``client.createChannel(server, name, type, callback)``
| **See:** client.createChannel_ | **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.leaveServer : ./docs_client.html#leaveserver-server-callback
.. _client.createInvite : ./docs_client.html#createinvite-channel-options-callback .. _client.createInvite : ./docs_client.html#createinvite-channel-options-callback
.. _client.createRole : ./docs_client.html#createrole-server-data-callback .. _client.createRole : ./docs_client.html#createrole-server-data-callback
.. _client.createChannel : ./docs_client.html#createchannel-server-name-type-callback .. _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