Struct serenity::builder::EditVoiceState

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

A builder which edits a user’s voice state, to be used in conjunction with GuildChannel::edit_voice_state.

Tuple Fields

0: HashMap<&'static str, Value>

Implementations

impl EditVoiceState

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

Whether to suppress the user. Setting this to false will invite a user to speak.

Requires the Mute Members permission to suppress another user or unsuppress the current user.

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

Requests or clears a request to speak. This is equivalent to passing the current time to Self::request_to_speak_timestamp.

Requires the Request to Speak permission.

pub fn request_to_speak_timestamp<T: Into<Timestamp>>(
    &mut self,
    timestamp: Option<T>
) -> &mut Self

Sets the current bot user’s request to speak timestamp. This can be any present or future time. Set this to None to clear a request to speak.

Requires the Request to Speak permission.

Trait Implementations

impl Clone for EditVoiceState

fn clone(&self) -> EditVoiceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditVoiceState

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

Formats the value using the given formatter.

impl Default for EditVoiceState

fn default() -> EditVoiceState

Returns the “default value” for a type.