builder
only.Expand description
A builder to optionally edit certain fields of a Guild
. This is meant
for usage with Guild::edit
.
Note: Editing a guild requires that the current user have the Manage Guild permission.
Tuple Fields
0: HashMap<&'static str, Value>
Implementations
sourceimpl EditGuild
impl EditGuild
sourcepub fn afk_channel<C: Into<ChannelId>>(
&mut self,
channel: Option<C>
) -> &mut Self
pub fn afk_channel<C: Into<ChannelId>>(
&mut self,
channel: Option<C>
) -> &mut Self
Set the “AFK voice channel” that users are to move to if they have been
AFK for an amount of time, configurable by Self::afk_timeout
.
The given channel must be either some valid voice channel, or None
to
not set an AFK channel. The library does not check if a channel is
valid.
sourcepub fn afk_timeout(&mut self, timeout: u64) -> &mut Self
pub fn afk_timeout(&mut self, timeout: u64) -> &mut Self
Set the amount of time a user is to be moved to the AFK channel -
configured via Self::afk_channel
- after being AFK.
sourcepub fn icon(&mut self, icon: Option<&str>) -> &mut Self
pub fn icon(&mut self, icon: Option<&str>) -> &mut Self
Set the icon of the guild. Pass None
to remove the icon.
Examples
Using the utility function - utils::read_image
- to read an image
from the cwd and encode it in base64 to send to Discord.
use serenity::utils;
// assuming a `guild` has already been bound
let base64_icon = utils::read_image("./guild_icon.png")?;
guild.edit(&http, |g| g.icon(Some(&base64_icon))).await?;
sourcepub fn name<S: ToString>(&mut self, name: S) -> &mut Self
pub fn name<S: ToString>(&mut self, name: S) -> &mut Self
Set the name of the guild.
Note: Must be between (and including) 2-100 characters.
sourcepub fn description<S: ToString>(&mut self, name: S) -> &mut Self
pub fn description<S: ToString>(&mut self, name: S) -> &mut Self
Set the description of the guild.
Note: Requires that the guild have the DISCOVERABLE
feature enabled.
You can check this through a guild’s features
list.
sourcepub fn features(&mut self, features: Vec<String>) -> &mut Self
pub fn features(&mut self, features: Vec<String>) -> &mut Self
Set the features of the guild.
Note: Requires that the guild have the DISCOVERABLE
feature enabled.
You can check this through a guild’s features
list.
sourcepub fn owner<U: Into<UserId>>(&mut self, user_id: U) -> &mut Self
pub fn owner<U: Into<UserId>>(&mut self, user_id: U) -> &mut Self
Transfers the ownership of the guild to another user by Id.
Note: The current user must be the owner of the guild.
sourcepub fn splash(&mut self, splash: Option<&str>) -> &mut Self
pub fn splash(&mut self, splash: Option<&str>) -> &mut Self
Set the splash image of the guild on the invitation page.
The splash
must be base64-encoded 1024x1024 png/jpeg/gif image-data.
Requires that the guild have the INVITE_SPLASH
feature enabled.
You can check this through a guild’s features
list.
sourcepub fn discovery_splash(&mut self, splash: Option<&str>) -> &mut Self
pub fn discovery_splash(&mut self, splash: Option<&str>) -> &mut Self
Set the splash image of the guild on the discovery page.
The splash
must be base64-encoded 1024x1024 png/jpeg/gif image-data.
Requires that the guild have the DISCOVERABLE
feature enabled.
You can check this through a guild’s features
list.
Set the banner image of the guild, it appears on the left side-bar.
The banner
must be base64-encoded 16:9 png/jpeg image data.
Requires that the guild have the BANNER
feature enabled.
You can check this through a guild’s features
list.
sourcepub fn system_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self
pub fn system_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self
Set the channel ID where welcome messages and boost events will be posted.
sourcepub fn rules_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self
pub fn rules_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self
Set the channel ID of the rules and guidelines channel.
Note: This feature is for Community guilds only.
sourcepub fn public_updates_channel_id(
&mut self,
channel_id: Option<ChannelId>
) -> &mut Self
pub fn public_updates_channel_id(
&mut self,
channel_id: Option<ChannelId>
) -> &mut Self
Set the channel ID where admins and moderators receive update messages from Discord.
Note: This feature is for Community guilds only.
sourcepub fn preferred_locale(&mut self, locale: Option<&str>) -> &mut Self
pub fn preferred_locale(&mut self, locale: Option<&str>) -> &mut Self
Set the preferred locale used in Server Discovery and update messages from Discord.
If this is not set, the locale will default to “en-US”;
Note: This feature is for Community guilds only.
sourcepub fn explicit_content_filter(
&mut self,
level: Option<ExplicitContentFilter>
) -> &mut Self
pub fn explicit_content_filter(
&mut self,
level: Option<ExplicitContentFilter>
) -> &mut Self
Set the content filter level.
sourcepub fn default_message_notifications(
&mut self,
level: Option<DefaultMessageNotificationLevel>
) -> &mut Self
pub fn default_message_notifications(
&mut self,
level: Option<DefaultMessageNotificationLevel>
) -> &mut Self
Set the default message notification level.
sourcepub fn verification_level<V>(&mut self, verification_level: V) -> &mut Self where
V: Into<VerificationLevel>,
pub fn verification_level<V>(&mut self, verification_level: V) -> &mut Self where
V: Into<VerificationLevel>,
Set the verification level of the guild. This can restrict what a user must have prior to being able to send messages in a guild.
Refer to the documentation for VerificationLevel
for more
information on each variant.
Examples
Setting the verification level to High
:
use serenity::model::guild::VerificationLevel;
// assuming a `guild` has already been bound
let edit = guild.edit(&http, |g| g.verification_level(VerificationLevel::High)).await;
if let Err(why) = edit {
println!("Error setting verification level: {:?}", why);
}
sourcepub fn system_channel_flags(
&mut self,
system_channel_flags: SystemChannelFlags
) -> &mut Self
pub fn system_channel_flags(
&mut self,
system_channel_flags: SystemChannelFlags
) -> &mut Self
Modifies the notifications that are sent by discord to the configured system channel.
use serenity::model::guild::SystemChannelFlags;
// assuming a `guild` has already been bound
let edit = guild
.edit(&http, |g| {
g.system_channel_flags(
SystemChannelFlags::SUPPRESS_JOIN_NOTIFICATIONS
| SystemChannelFlags::SUPPRESS_GUILD_REMINDER_NOTIFICATIONS,
)
})
.await;
if let Err(why) = edit {
println!("Error setting verification level: {:?}", why);
}
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for EditGuild
impl Send for EditGuild
impl Sync for EditGuild
impl Unpin for EditGuild
impl UnwindSafe for EditGuild
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more