mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-17 20:13:30 +01:00
Added role docs
This commit is contained in:
74
docs/docs_role.rst
Normal file
74
docs/docs_role.rst
Normal 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.
|
||||||
@@ -38,6 +38,7 @@ Contents:
|
|||||||
docs_user
|
docs_user
|
||||||
docs_message
|
docs_message
|
||||||
docs_invite
|
docs_invite
|
||||||
|
docs_role
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|||||||
@@ -10,5 +10,6 @@
|
|||||||
.. _Message : ./docs_message.html
|
.. _Message : ./docs_message.html
|
||||||
.. _Invite : ./docs_invite.html
|
.. _Invite : ./docs_invite.html
|
||||||
.. _Equality : ./docs_equality.html
|
.. _Equality : ./docs_equality.html
|
||||||
|
.. _Role : ./docs_role.html
|
||||||
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
|
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
|
||||||
.. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter
|
.. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter
|
||||||
Reference in New Issue
Block a user