Struct EditVoiceState

pub struct EditVoiceState { /* private fields */ }

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

Discord docs:

• current user
• other users

Implementations

impl EditVoiceState

pub fn new() -> Self

Equivalent to Self::default.

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

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

Note: Requires the Mute Members permission to suppress another user or unsuppress the current user. This is not required if suppressing the current user.

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

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

Note: Requires the Request to Speak permission.

pub fn request_to_speak_timestamp(self, timestamp: impl Into<Timestamp>) -> Self

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

Note: Requires the Request to Speak permission.

Trait Implementations

impl Builder for EditVoiceState

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Edits the given user’s voice state in a stage channel. Providing a UserId will edit that user’s voice state, otherwise the current user’s voice state will be edited.

Note: Requires the Request to Speak permission. Also requires the Mute Members permission to suppress another user or unsuppress the current user. This is not required if suppressing the current user.

Errors

Returns Error::Http if the user lacks permission, or if invalid data is given.

type Context<'ctx> = (GuildId, ChannelId, Option<UserId>)

Additional data that’s only required when sending a request off to the API.

type Built = ()

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.

impl Serialize for EditVoiceState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.