Added channel permissions

This commit is contained in:
hydrabolt
2015-11-20 21:34:21 +00:00
parent 4c29e2ce9b
commit c5f81298f9
3 changed files with 38 additions and 0 deletions

View File

@@ -0,0 +1,36 @@
.. include:: ./vars.rst
ChannelPermissions
==================
ChannelPermissions is used to represent the final permissions of a user in a channel, to see exactly what they are and aren't allowed to do.
-----------
Functions
---------
------------
serialize()
~~~~~~~~~~~
**Aliases:** `serialise`
Returns an object containing permission names and values. E.g:
.. code-block:: js
{
createInstantInvite : true,
kickMembers : false
}
For more on valid permission names, see `Permission Constants`_.
hasPermission(permission)
~~~~~~~~~~~~~~~~~~~~~~~~~
Sees whether the user has the permission given.
- **permission** - See `Permission Constants`_ for valid permission names.

View File

@@ -45,6 +45,7 @@ Contents:
docs_role
docs_permissionoverwrite
docs_channelpermissions
.. toctree::
:maxdepth: 2

View File

@@ -11,6 +11,7 @@
.. _Invite : ./docs_invite.html
.. _Equality : ./docs_equality.html
.. _Role : ./docs_role.html
.. _ChannelPermissions : ./docs_channelpermissions.html
.. _PermissionOverwrite : ./docs_permissionoverwrite.html
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter