diff --git a/docs/docs_member.rst b/docs/docs_member.rst new file mode 100644 index 000000000..f610534d2 --- /dev/null +++ b/docs/docs_member.rst @@ -0,0 +1,41 @@ +.. include:: ./vars.rst + +Member Documentation +================== + +The Member Class is used to represent a User_ but specific to a server. **Any attributes/functions available in User_ are omitted.** + +Attributes +---------- + +server +~~~~~~ + +The Server_ that the Member belongs to. + +roles +~~~~~ + +An `Array` of ServerPermissions_ and ChannelPermissions_ that the Member is affected by. + +rawRoles +~~~~~~~~ + +An `Array` of role IDs. + +Functions +--------- + +hasRole(role) +~~~~~~~~~~~~~ + +Returns a `Boolean` depending on whether or not a user has a certain role. + +- **role** - The ServerPermissions_ you want to see if a user has. + +permissionsIn(channel) +~~~~~~~~~~~~~~~~~~~~~~ + +Returns an EvaluatedPermissions_ giving the final permissions of the Member in a channel. + +- **channel** - The Channel_ that you want to evaluate the permissions in. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 488a136cb..195946991 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Contents: docs_resolvable docs_client docs_user + docs_member docs_server docs_channel docs_pmchannel diff --git a/docs/vars.rst b/docs/vars.rst index eddaba309..fe4493501 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -11,4 +11,5 @@ .. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise .. _ServerPermissions : ./docs_permissions.html#id1 .. _ChannelPermissions : ./docs_permissions.html#id3 -.. _EvaluatedPermissions : ./docs_permissions.html#id6 \ No newline at end of file +.. _EvaluatedPermissions : ./docs_permissions.html#id6 +.. _Member : ./docs_member.html \ No newline at end of file