Files
discord.js/docs/docs_serverchannel.rst
Manuel Kraus ad84aa84b8 Some doc fixes (#315)
#docs_client.rst:
- 257: Add proper eplanation of callback, like in every other method
- 433: Fix linking for Invite Resolvable

#docs_message.rst:
- 90 : Replace ':' with '-', just for consistency with the others

#docs_resolvables.rst:
- 92 : String doesn't link to anything (?) -> Link removed

#docs_servers.rst:
- 109 : Properly indent code-block because it didn't show at all on rtfd

#docs_serverchannel.rst:
- 53 : Remove doulbe '`' causing it not to display properly

#docs_voiceconnection.rst:
- 67 : Remove 'currently, it currently

#docs_voiceconnection.rst:
- 32 : Add links for Role Resolvable, as used in client#addMemberToRole,
client#removeMemberFromRole and client#memberHasRole
2016-05-02 13:05:09 -07:00

54 lines
844 B
ReStructuredText

.. include:: ./vars.rst
ServerChannel
=============
**extends** Channel_
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.