Finished channels

This commit is contained in:
hydrabolt
2015-11-20 20:44:09 +00:00
parent d26702f48f
commit 19fb8e6dfd
10 changed files with 127 additions and 14 deletions

View File

@@ -0,0 +1,49 @@
.. include:: ./vars.rst
ServerChannel
=============
A ServerChannel is a Channel_ that belongs to a Server_.
Attributes
----------
name
~~~~
`String`, name of the channel.
type
~~~~
`String`, either ``voice`` or ``text``.
position
~~~~~~~~
`Number`, position in the channel list.
permissionOverwrites
~~~~~~~~~~~~~~~~~~~~
Cache_ of all the PermissionOverwrite_ objects affecting the channel.
server
~~~~~~
Server_ the channel belongs to.
Functions
---------
permissionsOf(user)
~~~~~~~~~~~~~~~~~~~
**Aliases:** permsOf
Returns a ChannelPermissions_ object of a user's permissions in that channel.
mention()
~~~~~~~~~
Returns a `string` that can be used in discord messages to mention a channel. ``serverChannel.toString()` defaults to this.