Added role docs

This commit is contained in:
hydrabolt
2015-11-20 21:14:35 +00:00
parent 882dde0610
commit 703b56f394
3 changed files with 76 additions and 0 deletions

74
docs/docs_role.rst Normal file
View File

@@ -0,0 +1,74 @@
.. include:: ./vars.rst
Role
====
Represents data for a Server Role.
-----------
Attributes
----------
--------
position
~~~~~~~~
`Number`, position of the role when viewing the roles of a server.
name
~~~~
`String`, name of the role.
managed
~~~~~~~
`Boolean`, whether Discord has created the role itself. Currently only used for Twitch integration.
id
~~
`String`, ID of the role.
hoist
~~~~~
`Boolean`, whether the role should be displayed as a separate category in the users section.
color
~~~~~
`Number`, a base 10 colour. Use ``role.colorAsHex()`` to get a hex colour instead.
server
~~~~~~
The Server_ the role belongs to.
client
~~~~~~
The Client_ that cached the role.
------
Functions
---------
-------
serialise()
~~~~~~~~~~~
**Aliases:** `serialize`
Makes an object with the permission names found in `Permission Constants`_ and a boolean value for them.
hasPermission(permission)
~~~~~~~~~~~~~~~~~~~~~~~~~
Sees whether the role has the permission given.
- **permission** - See `Permission Constants`_ for valid permission names.

View File

@@ -38,6 +38,7 @@ Contents:
docs_user
docs_message
docs_invite
docs_role
.. toctree::
:maxdepth: 2

View File

@@ -10,5 +10,6 @@
.. _Message : ./docs_message.html
.. _Invite : ./docs_invite.html
.. _Equality : ./docs_equality.html
.. _Role : ./docs_role.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