diff --git a/docs/docs_channelpermissions.rst b/docs/docs_channelpermissions.rst new file mode 100644 index 000000000..cba8463e3 --- /dev/null +++ b/docs/docs_channelpermissions.rst @@ -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. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 5c68fc759..94e00758c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,6 +45,7 @@ Contents: docs_role docs_permissionoverwrite + docs_channelpermissions .. toctree:: :maxdepth: 2 diff --git a/docs/vars.rst b/docs/vars.rst index f67e7583f..f0d6fb161 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -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 \ No newline at end of file