1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
use std::collections::HashMap;
use crate::internal::prelude::*;
use crate::model::prelude::*;
/// 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.
///
/// [`Guild::edit`]: crate::model::guild::Guild::edit
/// [`Guild`]: crate::model::guild::Guild
/// [Manage Guild]: crate::model::permissions::Permissions::MANAGE_GUILD
#[derive(Clone, Debug, Default)]
pub struct EditGuild(pub HashMap<&'static str, Value>);
impl EditGuild {
/// 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.
#[inline]
pub fn afk_channel<C: Into<ChannelId>>(&mut self, channel: Option<C>) -> &mut Self {
self._afk_channel(channel.map(Into::into));
self
}
fn _afk_channel(&mut self, channel: Option<ChannelId>) {
self.0.insert("afk_channel_id", match channel {
Some(channel) => Value::Number(Number::from(channel.0)),
None => Value::Null,
});
}
/// Set the amount of time a user is to be moved to the AFK channel -
/// configured via [`Self::afk_channel`] - after being AFK.
pub fn afk_timeout(&mut self, timeout: u64) -> &mut Self {
self.0.insert("afk_timeout", Value::Number(Number::from(timeout)));
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.
///
/// ```rust,no_run
/// # use serenity::{http::Http, model::id::GuildId};
/// #
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http = Http::default();
/// # let mut guild = GuildId(0).to_partial_guild(&http).await?;
/// use serenity::utils;
///
/// // assuming a `guild` has already been bound
///
/// let base64_icon = utils::read_image("./guild_icon.png")?;
///
/// guild.edit(&http, |mut g| g.icon(Some(&base64_icon))).await?;
/// # Ok(())
/// # }
/// ```
///
/// [`utils::read_image`]: crate::utils::read_image
pub fn icon(&mut self, icon: Option<&str>) -> &mut Self {
self.0.insert("icon", icon.map_or_else(|| Value::Null, |x| Value::String(x.to_string())));
self
}
/// Set the name of the guild.
///
/// **Note**: Must be between (and including) 2-100 chracters.
pub fn name<S: ToString>(&mut self, name: S) -> &mut Self {
self.0.insert("name", Value::String(name.to_string()));
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.
///
/// [`features`]: crate::model::guild::Guild::features
pub fn description<S: ToString>(&mut self, name: S) -> &mut Self {
self.0.insert("name", Value::String(name.to_string()));
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.
///
/// [`features`]: crate::model::guild::Guild::features
pub fn features(&mut self, features: Vec<String>) -> &mut Self {
let mut values: Vec<Value> = vec![];
for value in features {
values.push(Value::String(value));
}
self.0.insert("features", Value::Array(values));
self
}
/// Transfers the ownership of the guild to another user by Id.
///
/// **Note**: The current user must be the owner of the guild.
#[inline]
pub fn owner<U: Into<UserId>>(&mut self, user_id: U) -> &mut Self {
self._owner(user_id.into());
self
}
fn _owner(&mut self, user_id: UserId) {
let id = Value::Number(Number::from(user_id.0));
self.0.insert("owner_id", id);
}
/// Set the voice region of the server.
///
/// # Examples
///
/// Setting the region to [`Region::UsWest`]:
///
/// ```rust,no_run
/// # use serenity::{http::Http, model::id::GuildId};
/// #
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http = Http::default();
/// # let mut guild = GuildId(0).to_partial_guild(&http).await?;
/// use serenity::model::guild::Region;
///
/// // assuming a `guild` has already been bound
///
/// guild.edit(&http, |g| g.region(Region::UsWest)).await?;
/// # Ok(())
/// # }
/// ```
#[deprecated(note = "Regions are now set per voice channel instead of globally.")]
#[allow(deprecated)]
pub fn region(&mut self, region: Region) -> &mut Self {
self.0.insert("region", Value::String(region.name().to_string()));
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.
///
/// [`features`]: crate::model::guild::Guild::features
pub fn splash(&mut self, splash: Option<&str>) -> &mut Self {
let splash = splash.map_or(Value::Null, |x| Value::String(x.to_string()));
self.0.insert("splash", splash);
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.
///
/// [`features`]: crate::model::guild::Guild::features
pub fn discovery_splash(&mut self, splash: Option<&str>) -> &mut Self {
let splash = splash.map_or(Value::Null, |x| Value::String(x.to_string()));
self.0.insert("splash", splash);
self
}
/// 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.
///
/// [`features`]: crate::model::guild::Guild::features
pub fn banner(&mut self, banner: Option<&str>) -> &mut Self {
let banner = banner.map_or(Value::Null, |x| Value::String(x.to_string()));
self.0.insert("banner", banner);
self
}
/// Set the channel ID where welcome messages and boost events will be
/// posted.
pub fn system_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self {
let channel_id = channel_id.map_or(Value::Null, |x| Value::from(x.0));
self.0.insert("system_channel_id", channel_id);
self
}
/// Set the channel ID of the rules and guidelines channel.
///
/// **Note**:
/// This feature is for Community guilds only.
pub fn rules_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self {
let channel_id = channel_id.map_or(Value::Null, |x| Value::from(x.0));
self.0.insert("rules_channel_id", channel_id);
self
}
/// Set the channel ID where admins and moderators receive update messages
/// from Discord.
///
/// **Note**:
/// This feature is for Community guilds only.
pub fn public_updates_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self {
let channel_id = channel_id.map_or(Value::Null, |x| Value::from(x.0));
self.0.insert("public_updates_channel_id", channel_id);
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.
pub fn preferred_locale(&mut self, locale: Option<&str>) -> &mut Self {
let locale = locale.map_or(Value::Null, |x| Value::String(x.to_string()));
self.0.insert("preferred_locale", locale);
self
}
/// Set the content filter level.
pub fn explicit_content_filter(&mut self, level: Option<ExplicitContentFilter>) -> &mut Self {
let level = level.map_or(Value::Null, |x| Value::from(x as u8));
self.0.insert("explicit_content_filter", level);
self
}
/// Set the default message notification level.
pub fn default_message_notifications(
&mut self,
level: Option<DefaultMessageNotificationLevel>,
) -> &mut Self {
let level = level.map_or(Value::Null, |x| Value::from(x as u8));
self.0.insert("default_message_notifications", level);
self
}
/// 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`][`VerificationLevel::High`]:
///
/// ```rust,no_run
/// # use serenity::{http::Http, model::id::GuildId};
/// #
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http = Http::default();
/// # let mut guild = GuildId(0).to_partial_guild(&http).await?;
/// 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);
/// }
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn verification_level<V>(&mut self, verification_level: V) -> &mut Self
where
V: Into<VerificationLevel>,
{
self._verification_level(verification_level.into());
self
}
fn _verification_level(&mut self, verification_level: VerificationLevel) {
let num = Value::Number(Number::from(verification_level.num()));
self.0.insert("verification_level", num);
}
/// Modifies the notifications that are sent by discord to the configured system channel.
///
/// ```rust,no_run
/// # use serenity::{http::Http, model::id::GuildId};
/// #
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http = Http::default();
/// # let mut guild = GuildId(0).to_partial_guild(&http).await?;
/// 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);
/// }
/// # Ok(())
/// # }
/// ```
pub fn system_channel_flags(&mut self, system_channel_flags: SystemChannelFlags) -> &mut Self {
self.0.insert("system_channel_flags", system_channel_flags.bits().into());
self
}
}