mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-19 04:53:30 +01:00
More docs
This commit is contained in:
80
docs/docs_permissions.rst
Normal file
80
docs/docs_permissions.rst
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
.. include:: ./vars.rst
|
||||||
|
|
||||||
|
Permissions Documentation
|
||||||
|
=========================
|
||||||
|
|
||||||
|
The Permissions Class represents data of permissions/roles.
|
||||||
|
|
||||||
|
ServerPermissions
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
ServerPermissions are also known as roles. They give the general gist of permissions of all users in a Server.
|
||||||
|
|
||||||
|
name
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
`String` that is the name of the role.
|
||||||
|
|
||||||
|
color
|
||||||
|
~~~~~
|
||||||
|
|
||||||
|
`Number` that is the color of role, use Discord.Color to resolve (see source code under refs/colors.js)
|
||||||
|
|
||||||
|
hoist
|
||||||
|
~~~~~
|
||||||
|
|
||||||
|
`Boolean`, whether the role should be a separate category in the users list.
|
||||||
|
|
||||||
|
managed
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
`Boolean`, whether the permission is managed by Discord. Currently only used by Twitch integration.
|
||||||
|
|
||||||
|
position
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
`Number`, the position of the role that states its importance.
|
||||||
|
|
||||||
|
id
|
||||||
|
~~
|
||||||
|
|
||||||
|
`Number`, the ID of the role.
|
||||||
|
|
||||||
|
server
|
||||||
|
~~~~~~
|
||||||
|
|
||||||
|
Server_ that the role belongs to.
|
||||||
|
|
||||||
|
Actual Permissions:
|
||||||
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
`Actual Permissions` is not an attribute, however the following permissions are attributes of ServerPermissions. They are self-explanatory.
|
||||||
|
|
||||||
|
.. code-block:: js
|
||||||
|
|
||||||
|
{
|
||||||
|
createInstantInvite,
|
||||||
|
manageRoles, // if this is true all the others are true
|
||||||
|
manageChannels,
|
||||||
|
readMessages,
|
||||||
|
sendMessages,
|
||||||
|
sendTTSMessages,
|
||||||
|
manageMessages, // deleting, editing etc
|
||||||
|
embedLinks,
|
||||||
|
attachFiles,
|
||||||
|
readMessageHistory,
|
||||||
|
mentionEveryone,
|
||||||
|
voiceConnect,
|
||||||
|
voiceSpeak,
|
||||||
|
voiceMuteMembers,
|
||||||
|
voiceDeafenMembers,
|
||||||
|
voiceMoveMembers,
|
||||||
|
voiceUseVoiceActivation
|
||||||
|
}
|
||||||
|
|
||||||
|
serialize()
|
||||||
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
**Aliases** : *serialise()*
|
||||||
|
|
||||||
|
To get a valid `Object` of the actual permissions of the object, just do `serverPermissions.serialise()` to get an object with the above mentioned permissions
|
||||||
@@ -9,3 +9,6 @@
|
|||||||
.. _Channel Resolvable : ./docs_resolvable.html#channel-resolvable
|
.. _Channel Resolvable : ./docs_resolvable.html#channel-resolvable
|
||||||
.. _Invite Resolvable : ./docs_resolvable.html#invite-resolvable
|
.. _Invite Resolvable : ./docs_resolvable.html#invite-resolvable
|
||||||
.. _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
|
||||||
|
.. _ServerPermissions : ./docs_permissions.html#ServerPermissions
|
||||||
|
.. _ChannelPermissions : ./docs_permissions.html#ChannelPermissions
|
||||||
|
.. _EvaluatedPermissions : ./docs_permissions.html#EvaluatedPermissions
|
||||||
@@ -41,11 +41,15 @@ var ServerPermissions = (function () {
|
|||||||
voiceSpeak: this.voiceSpeak,
|
voiceSpeak: this.voiceSpeak,
|
||||||
voiceMuteMembers: this.voiceMuteMembers,
|
voiceMuteMembers: this.voiceMuteMembers,
|
||||||
voiceDeafenMembers: this.voiceDeafenMembers,
|
voiceDeafenMembers: this.voiceDeafenMembers,
|
||||||
voiceMoveMember: this.voiceMoveMembers,
|
voiceMoveMembers: this.voiceMoveMembers,
|
||||||
voiceUseVoiceActivation: this.voiceUseVoiceActivation
|
voiceUseVoiceActivation: this.voiceUseVoiceActivation
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
ServerPermissions.prototype.serialize = function serialize() {
|
||||||
|
return this.serialise();
|
||||||
|
};
|
||||||
|
|
||||||
ServerPermissions.prototype.getBit = function getBit(x) {
|
ServerPermissions.prototype.getBit = function getBit(x) {
|
||||||
if ((this.packed >>> 3 & 1) === 1) {
|
if ((this.packed >>> 3 & 1) === 1) {
|
||||||
return true;
|
return true;
|
||||||
|
|||||||
@@ -35,11 +35,15 @@ class ServerPermissions {
|
|||||||
voiceSpeak: this.voiceSpeak,
|
voiceSpeak: this.voiceSpeak,
|
||||||
voiceMuteMembers: this.voiceMuteMembers,
|
voiceMuteMembers: this.voiceMuteMembers,
|
||||||
voiceDeafenMembers: this.voiceDeafenMembers,
|
voiceDeafenMembers: this.voiceDeafenMembers,
|
||||||
voiceMoveMember: this.voiceMoveMembers,
|
voiceMoveMembers: this.voiceMoveMembers,
|
||||||
voiceUseVoiceActivation: this.voiceUseVoiceActivation
|
voiceUseVoiceActivation: this.voiceUseVoiceActivation
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
serialize(){
|
||||||
|
return this.serialise();
|
||||||
|
}
|
||||||
|
|
||||||
get createInstantInvite() { return this.getBit(0); }
|
get createInstantInvite() { return this.getBit(0); }
|
||||||
set createInstantInvite(val) { this.setBit(0, val); }
|
set createInstantInvite(val) { this.setBit(0, val); }
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user