Struct serenity::builder::EditMember

pub struct EditMember(pub HashMap<&'static str, Value>);

A builder which edits the properties of a Member, to be used in conjunction with Member::edit.

Tuple Fields

0: HashMap<&'static str, Value>

Implementations

impl EditMember

pub fn deafen(&mut self, deafen: bool) -> &mut Self

Whether to deafen the member.

Requires the Deafen Members permission.

pub fn mute(&mut self, mute: bool) -> &mut Self

Whether to mute the member.

Requires the Mute Members permission.

pub fn nickname<S: ToString>(&mut self, nickname: S) -> &mut Self

Changes the member’s nickname. Pass an empty string to reset the nickname.

Requires the Manage Nicknames permission.

pub fn roles<T: AsRef<RoleId>, It: IntoIterator<Item = T>>(
    &mut self,
    roles: It
) -> &mut Self

Set the list of roles that the member should have.

Requires the Manage Roles permission to modify.

pub fn voice_channel<C: Into<ChannelId>>(&mut self, channel_id: C) -> &mut Self

The Id of the voice channel to move the member to.

Requires the Move Members permission.

pub fn disconnect_member(&mut self) -> &mut Self

Disconnects the user from their voice channel if any

Requires the Move Members permission.

pub fn disable_communication_until(&mut self, time: String) -> &mut Self

Times the user out until time, an ISO8601-formatted datetime string.

time is considered invalid if it is not a valid ISO8601 timestamp or if it is greater than 28 days from the current time.

Requires the Moderate Members permission.

pub fn disable_communication_until_datetime<Tz>(
    &mut self,
    time: DateTime<Tz>
) -> &mut Self where
    Tz: TimeZone,
    Tz::Offset: Display, 

Times the user out until time.

time is considered invalid if it is greater than 28 days from the current time. Requires the Moderate Members permission.

pub fn enable_communication(&mut self) -> &mut Self

Allow a user to communicate, removing their timeout, if there is one.

Requires the Moderate Members permission.

Trait Implementations

impl Clone for EditMember

fn clone(&self) -> EditMember

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EditMember

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EditMember

fn default() -> EditMember

Returns the “default value” for a type.