aboutsummaryrefslogtreecommitdiff
path: root/src/utils/builder
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2016-12-04 15:38:06 -0800
committerAustin Hellyer <[email protected]>2016-12-04 15:38:06 -0800
commitd1441363364970b749d57b8a4863b284239488d1 (patch)
tree8758f7e9ab6afab82492f18736fcb9803836cab7 /src/utils/builder
parentAdd documentation for models (diff)
downloadserenity-d1441363364970b749d57b8a4863b284239488d1.tar.xz
serenity-d1441363364970b749d57b8a4863b284239488d1.zip
Add more Context docs+permission requirements
Add more documentation to most of the Context methods, also clarifying which permission/s are required for each method.
Diffstat (limited to 'src/utils/builder')
-rw-r--r--src/utils/builder/edit_member.rs23
1 files changed, 22 insertions, 1 deletions
diff --git a/src/utils/builder/edit_member.rs b/src/utils/builder/edit_member.rs
index 845b43d..cb67214 100644
--- a/src/utils/builder/edit_member.rs
+++ b/src/utils/builder/edit_member.rs
@@ -3,30 +3,47 @@ use std::default::Default;
use ::model::{ChannelId, RoleId};
/// A builder which edits the properties of a [`Member`], to be used in
-/// conjunction with [`Context::edit_member`].
+/// conjunction with [`Context::edit_member`] and [`Member::edit`].
///
/// [`Context::edit_member`]: ../../client/struct.Context.html#method.edit_member
/// [`Member`]: ../../model/struct.Member.html
+/// [`Member::edit`]: ../../model/struct.Member.html#method.edit
pub struct EditMember(pub ObjectBuilder);
impl EditMember {
/// Whether to deafen the member.
+ ///
+ /// Requires the [Deafen Members] permission.
+ ///
+ /// [Deafen Members]: ../../model/permissions/constant.DEAFEN_MEMBERS.html
pub fn deafen(self, deafen: bool) -> Self {
EditMember(self.0.insert("deaf", deafen))
}
/// Whether to mute the member.
+ ///
+ /// Requires the [Mute Members] permission.
+ ///
+ /// [Mute Members]: ../../model/permissions/constant.MUTE_MEMBERS.html
pub fn mute(self, mute: bool) -> Self {
EditMember(self.0.insert("mute", mute))
}
/// Changes the member's nickname. Pass an empty string to reset the
/// nickname.
+ ///
+ /// Requires the [Manage Nicknames] permission.
+ ///
+ /// [Manage Nicknames]: ../../model/permissions/constant.MANAGE_NICKNAMES.html
pub fn nickname(self, nickname: &str) -> Self {
EditMember(self.0.insert("nick", nickname))
}
/// Set the list of roles that the member should have.
+ ///
+ /// Requires the [Manage Roles] permission to modify.
+ ///
+ /// [Manage Roles]: ../../model/permissions/constant.MANAGE_ROLES.html
pub fn roles(self, roles: &[RoleId]) -> Self {
EditMember(self.0
.insert_array("roles",
@@ -34,6 +51,10 @@ impl EditMember {
}
/// The Id of the voice channel to move the member to.
+ ///
+ /// Requires the [Move Members] permission.
+ ///
+ /// [Move Members]: ../../model/permissions/constant.MOVE_MEMBERS.html
pub fn voice_channel<C: Into<ChannelId>>(self, channel_id: C) -> Self {
EditMember(self.0.insert("channel_id", channel_id.into().0))
}