#[non_exhaustive]pub struct PartialGuild {Show 36 fields
pub application_id: Option<ApplicationId>,
pub id: GuildId,
pub afk_channel_id: Option<ChannelId>,
pub afk_timeout: u64,
pub default_message_notifications: DefaultMessageNotificationLevel,
pub widget_enabled: Option<bool>,
pub widget_channel_id: Option<ChannelId>,
pub emojis: HashMap<EmojiId, Emoji>,
pub features: Vec<String>,
pub icon: Option<String>,
pub mfa_level: MfaLevel,
pub name: String,
pub owner_id: UserId,
pub owner: bool,
pub roles: HashMap<RoleId, Role>,
pub splash: Option<String>,
pub discovery_splash: Option<String>,
pub system_channel_id: Option<ChannelId>,
pub system_channel_flags: SystemChannelFlags,
pub rules_channel_id: Option<ChannelId>,
pub public_updates_channel_id: Option<ChannelId>,
pub verification_level: VerificationLevel,
pub description: Option<String>,
pub premium_tier: PremiumTier,
pub premium_subscription_count: u64,
pub banner: Option<String>,
pub vanity_url_code: Option<String>,
pub welcome_screen: Option<GuildWelcomeScreen>,
pub approximate_member_count: Option<u64>,
pub approximate_presence_count: Option<u64>,
pub nsfw_level: NsfwLevel,
pub max_video_channel_users: Option<u64>,
pub max_presences: Option<u64>,
pub max_members: Option<u64>,
pub permissions: Option<String>,
pub stickers: HashMap<StickerId, Sticker>,
}
Expand description
Partial information about a Guild
. This does not include information
like member data.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.application_id: Option<ApplicationId>
Application ID of the guild creator if it is bot-created.
id: GuildId
The unique Id identifying the guild.
This is equivalent to the Id of the default role (@everyone
) and also
that of the default channel (typically #general
).
afk_channel_id: Option<ChannelId>
Id of a voice channel that’s considered the AFK channel.
afk_timeout: u64
The amount of seconds a user can not show any activity in a voice channel before being moved to an AFK channel – if one exists.
default_message_notifications: DefaultMessageNotificationLevel
Indicator of whether notifications for all messages are enabled by default in the guild.
widget_enabled: Option<bool>
Whether or not the guild widget is enabled.
widget_channel_id: Option<ChannelId>
The channel id that the widget will generate an invite to, or null if set to no invite
emojis: HashMap<EmojiId, Emoji>
All of the guild’s custom emojis.
features: Vec<String>
Features enabled for the guild.
Refer to Guild::features
for more information.
icon: Option<String>
The hash of the icon used by the guild.
In the client, this appears on the guild list on the left-hand side.
mfa_level: MfaLevel
Indicator of whether the guild requires multi-factor authentication for
Role
s or User
s with moderation permissions.
name: String
The name of the guild.
owner_id: UserId
The Id of the User
who owns the guild.
owner: bool
Whether or not the user is the owner of the guild.
roles: HashMap<RoleId, Role>
A mapping of the guild’s roles.
splash: Option<String>
An identifying hash of the guild’s splash icon.
If the InviteSplash
feature is enabled, this can be used to generate
a URL to a splash image.
discovery_splash: Option<String>
An identifying hash of the guild discovery’s splash icon.
Note: Only present for guilds with the DISCOVERABLE
feature.
system_channel_id: Option<ChannelId>
The ID of the channel to which system messages are sent.
system_channel_flags: SystemChannelFlags
System channel flags.
rules_channel_id: Option<ChannelId>
The id of the channel where rules and/or guidelines are displayed.
Note: Only available on COMMUNITY
guild, see Self::features
.
public_updates_channel_id: Option<ChannelId>
The id of the channel where admins and moderators of Community guilds receive notices from Discord.
Note: Only available on COMMUNITY
guild, see Self::features
.
verification_level: VerificationLevel
Indicator of the current verification level of the guild.
description: Option<String>
The guild’s description, if it has one.
The server’s premium boosting level.
The total number of users currently boosting this server.
The guild’s banner, if it has one.
vanity_url_code: Option<String>
The vanity url code for the guild, if it has one.
welcome_screen: Option<GuildWelcomeScreen>
The welcome screen of the guild.
Note: Only available on COMMUNITY
guild, see Self::features
.
approximate_member_count: Option<u64>
Approximate number of members in this guild.
approximate_presence_count: Option<u64>
Approximate number of non-offline members in this guild.
nsfw_level: NsfwLevel
The guild NSFW state. See discord support article
.
max_video_channel_users: Option<u64>
The maximum amount of users in a video channel.
max_presences: Option<u64>
The maximum number of presences for the guild. The default value is currently 25000.
Note: It is in effect when it is None
.
max_members: Option<u64>
The maximum number of members for the guild.
permissions: Option<String>
The user permissions in the guild.
stickers: HashMap<StickerId, Sticker>
All of the guild’s custom stickers.
Implementations
sourceimpl PartialGuild
impl PartialGuild
sourcepub async fn automod_rules(self, http: impl AsRef<Http>) -> Result<Vec<Rule>>
Available on crate feature model
only.
pub async fn automod_rules(self, http: impl AsRef<Http>) -> Result<Vec<Rule>>
model
only.Gets all auto moderation Rule
s of this guild via HTTP.
Note: Requires the Manage Guild permission.
Errors
Returns Error::Http
if the guild is unavailable.
sourcepub async fn automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>
) -> Result<Rule>
Available on crate feature model
only.
pub async fn automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>
) -> Result<Rule>
model
only.Gets an auto moderation Rule
of this guild by its ID via HTTP.
Note: Requires the Manage Guild permission.
Errors
Returns Error::Http
if a rule with the given ID does not exist.
sourcepub async fn create_automod_rule(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule
) -> Result<Rule>
Available on crate feature model
only.
pub async fn create_automod_rule(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule
) -> Result<Rule>
model
only.Creates an auto moderation Rule
in the guild.
Note: Requires the Manage Guild permission.
Examples
Create a custom keyword filter to block the message and timeout the author.
use serenity::model::guild::automod::{Action, Trigger};
let _rule = guild
.create_automod_rule(&http, |r| {
r.name("foobar filter")
.trigger(Trigger::Keyword(vec!["foo*".to_string(), "*bar".to_string()]))
.actions(vec![Action::BlockMessage, Action::Timeout(60)])
})
.await;
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid values are set.
sourcepub async fn edit_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule
) -> Result<Rule>
Available on crate feature model
only.
pub async fn edit_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule
) -> Result<Rule>
model
only.Edit an auto moderation Rule
by its ID.
Note: Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid values are set.
sourcepub async fn delete_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>
) -> Result<()>
model
only.Deletes an auto moderation Rule
from the guild.
Note: Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if a rule with that Id does not exist.
sourcepub async fn ban(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8
) -> Result<()>
Available on crate feature model
only.
pub async fn ban(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8
) -> Result<()>
model
only.Ban a User
from the guild, deleting a number of
days’ worth of messages (dmd
) between the range 0 and 7.
Note: Requires the Ban Members permission.
Examples
Ban a member and remove all messages they’ve sent in the last 4 days:
// assumes a `user` and `guild` have already been bound
let _ = guild.ban(user, 4);
Errors
Returns a ModelError::DeleteMessageDaysAmount
if the number of
days’ worth of messages to delete is over the maximum.
Also may return Error::Http
if the current user lacks permission.
sourcepub async fn ban_with_reason(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>
) -> Result<()>
Available on crate feature model
only.
pub async fn ban_with_reason(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>
) -> Result<()>
model
only.sourcepub async fn bans(&self, http: impl AsRef<Http>) -> Result<Vec<Ban>>
Available on crate feature model
only.
pub async fn bans(&self, http: impl AsRef<Http>) -> Result<Vec<Ban>>
model
only.Gets a list of the guild’s bans.
Requires the Ban Members permission.
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn audit_logs(
self,
http: impl AsRef<Http>,
action_type: Option<u8>,
user_id: Option<UserId>,
before: Option<AuditLogEntryId>,
limit: Option<u8>
) -> Result<AuditLogs>
Available on crate feature model
only.
pub async fn audit_logs(
self,
http: impl AsRef<Http>,
action_type: Option<u8>,
user_id: Option<UserId>,
before: Option<AuditLogEntryId>,
limit: Option<u8>
) -> Result<AuditLogs>
model
only.Gets a list of the guild’s audit log entries
Note: Requires the View Audit Log permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an invalid value is given.
sourcepub async fn channels(
&self,
http: impl AsRef<Http>
) -> Result<HashMap<ChannelId, GuildChannel>>
Available on crate feature model
only.
pub async fn channels(
&self,
http: impl AsRef<Http>
) -> Result<HashMap<ChannelId, GuildChannel>>
model
only.Gets all of the guild’s channels over the REST API.
Errors
Returns Error::Http
if the current user is not in
the guild or if the guild is otherwise unavailable.
pub fn channel_id_from_name(
&self,
cache: impl AsRef<Cache>,
name: impl AsRef<str>
) -> Option<ChannelId>
model
and cache
only.sourcepub async fn create_channel(
&self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
Available on crate feature model
only.
pub async fn create_channel(
&self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
model
only.Creates a GuildChannel
in the guild.
Refer to Http::create_channel
for more information.
Requires the Manage Channels permission.
Examples
Create a voice channel in a guild with the name test
:
use serenity::model::ChannelType;
guild.create_channel(|c| c.name("test").kind(ChannelType::Voice));
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid data was given, such as the channel name being
too long.
sourcepub async fn create_emoji(
&self,
http: impl AsRef<Http>,
name: &str,
image: &str
) -> Result<Emoji>
Available on crate feature model
only.
pub async fn create_emoji(
&self,
http: impl AsRef<Http>,
name: &str,
image: &str
) -> Result<Emoji>
model
only.Creates an emoji in the guild with a name and base64-encoded image.
Refer to the documentation for Guild::create_emoji
for more
information.
Requires the Manage Emojis and Stickers permission.
Examples
See the EditProfile::avatar
example for an in-depth example as to
how to read an image from the filesystem and encode it as base64. Most
of the example can be applied similarly for this method.
Errors
Returns Error::Http
if the current user lacks permission,
if the emoji name is too long, or if the image is too large.
sourcepub async fn create_integration(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
Available on crate feature model
only.
pub async fn create_integration(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
model
only.Creates an integration for the guild.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Command> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
Available on crate feature model
only.
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Command> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
model
only.sourcepub async fn set_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<Command>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
Available on crate feature model
only.
pub async fn set_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<Command>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
model
only.Overrides all guild application commands.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<CommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
Available on crate feature model
only.
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<CommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
model
only.Creates a guild specific CommandPermission
.
Note: It will update instantly.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn set_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<CommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
Available on crate feature model
only.
pub async fn set_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<CommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
model
only.Same as create_application_command_permission
but allows to create
more than one permission per call.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<Command>>
Available on crate feature model
only.
pub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<Command>>
model
only.Get all guild application commands.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<Command>
Available on crate feature model
only.
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<Command>
model
only.Get a specific guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<Command> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
Available on crate feature model
only.
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<Command> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
model
only.Edit guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn delete_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<()>
model
only.Delete guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<CommandPermission>>
Available on crate feature model
only.
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<CommandPermission>>
model
only.Get all guild application commands permissions only.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<CommandPermission>
Available on crate feature model
only.
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<CommandPermission>
model
only.Get permissions for specific guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
sourcepub async fn create_role<F>(&self, http: impl AsRef<Http>, f: F) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
Available on crate feature model
only.
pub async fn create_role<F>(&self, http: impl AsRef<Http>, f: F) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
model
only.Creates a new role in the guild with the data set, if any.
See the documentation for Guild::create_role
on how to use this.
Note: Requires the Manage Roles permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an invalid value was set.
sourcepub async fn create_sticker<'a, F>(
&self,
cache_http: impl CacheHttp,
f: F
) -> Result<Sticker> where
for<'b> F: FnOnce(&'b mut CreateSticker<'a>) -> &'b mut CreateSticker<'a>,
Available on crate feature model
only.
pub async fn create_sticker<'a, F>(
&self,
cache_http: impl CacheHttp,
f: F
) -> Result<Sticker> where
for<'b> F: FnOnce(&'b mut CreateSticker<'a>) -> &'b mut CreateSticker<'a>,
model
only.Creates a new sticker in the guild with the data set, if any.
Note: Requires the Manage Emojis and Stickers permission.
Errors
If the cache
is enabled, returns a ModelError::InvalidPermissions
if the current user does not have permission to manage roles.
sourcepub async fn delete(&self, http: impl AsRef<Http>) -> Result<PartialGuild>
Available on crate feature model
only.
pub async fn delete(&self, http: impl AsRef<Http>) -> Result<PartialGuild>
model
only.Deletes the current guild if the current user is the owner of the guild.
Note: Requires the current user to be the owner of the guild.
Errors
Returns Error::Http
if the current user is not the owner of
the guild.
sourcepub async fn delete_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>
) -> Result<()>
model
only.Deletes an Emoji
from the guild.
Requires the Manage Emojis and Stickers permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an emoji with that Id does not exist in the guild.
sourcepub async fn delete_integration(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_integration(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
model
only.Deletes an integration by Id from the guild.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an integration with that Id does not exist in the guild.
sourcepub async fn delete_role(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_role(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>
) -> Result<()>
model
only.Deletes a Role
by Id from the guild.
Also see Role::delete
if you have the cache
and model
features
enabled.
Requires the Manage Roles permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if a Role with that Id does not exist in the Guild.
sourcepub async fn delete_sticker(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>
) -> Result<()>
Available on crate feature model
only.
pub async fn delete_sticker(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>
) -> Result<()>
model
only.Deletes a Sticker
by Id from the guild.
Requires the Manage Emojis and Stickers permission.
Errors
Returns Error::Http
if the current user lacks permission
to delete the sticker.
sourcepub async fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<()> where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
Available on crate feature model
only.
pub async fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<()> where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
model
only.Edits the current guild with new data where specified.
Note: Requires the current user to have the Manage Guild permission.
Errors
Returns Error::Http
if an invalid value is set, or if the current user
lacks permission to edit the guild.
sourcepub async fn edit_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
name: &str
) -> Result<Emoji>
Available on crate feature model
only.
pub async fn edit_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
name: &str
) -> Result<Emoji>
model
only.Edits an Emoji
’s name in the guild.
Also see Emoji::edit
if you have the cache
and methods
features
enabled.
Requires the Manage Emojis and Stickers permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an emoji with that Id does not exist in the guild.
sourcepub async fn edit_member<F>(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: F
) -> Result<Member> where
F: FnOnce(&mut EditMember) -> &mut EditMember,
Available on crate feature model
only.
pub async fn edit_member<F>(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: F
) -> Result<Member> where
F: FnOnce(&mut EditMember) -> &mut EditMember,
model
only.Edits the properties of member of the guild, such as muting or nicknaming them.
Refer to EditMember
’s documentation for a full list of methods and
permission restrictions.
Examples
Mute a member and set their roles to just one role with a predefined Id:
use serenity::model::GuildId;
GuildId(7).edit_member(user_id, |m| m.mute(true).roles(&vec![role_id])).await;
Errors
Returns Error::Http
if the current user lacks the necessary permissions.
sourcepub async fn edit_nickname(
&self,
http: impl AsRef<Http>,
new_nickname: Option<&str>
) -> Result<()>
Available on crate feature model
only.
pub async fn edit_nickname(
&self,
http: impl AsRef<Http>,
new_nickname: Option<&str>
) -> Result<()>
model
only.Edits the current user’s nickname for the guild.
Pass None
to reset the nickname.
Note: Requires the Change Nickname permission.
Errors
Returns Error::Http
if the current user lacks permission
to change their nickname.
sourcepub async fn edit_role<F>(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
f: F
) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
Available on crate feature model
only.
pub async fn edit_role<F>(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
f: F
) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
model
only.Edits a role, optionally setting its fields.
Requires the Manage Roles permission.
Examples
Make a role hoisted:
partial_guild.edit_role(&context, RoleId(7), |r| r.hoist(true));
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn edit_role_position(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
position: u64
) -> Result<Vec<Role>>
Available on crate feature model
only.
pub async fn edit_role_position(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
position: u64
) -> Result<Vec<Role>>
model
only.Edits the order of Role
s
Requires the Manage Roles permission.
Examples
Change the order of a role:
use serenity::model::id::RoleId;
partial_guild.edit_role_position(&context, RoleId(8), 2);
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn edit_sticker<F>(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>,
f: F
) -> Result<Sticker> where
F: FnOnce(&mut EditSticker) -> &mut EditSticker,
Available on crate feature model
only.
pub async fn edit_sticker<F>(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>,
f: F
) -> Result<Sticker> where
F: FnOnce(&mut EditSticker) -> &mut EditSticker,
model
only.Edits a sticker, optionally setting its fields.
Requires the Manage Emojis and Stickers permission.
Examples
Rename a sticker:
guild.edit_sticker(&context, StickerId(7), |r| r.name("Bun bun meow"));
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
Available on crate feature model
only.
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
model
only.Edits the GuildWelcomeScreen
.
Errors
Returns an Error::Http
if some mandatory fields are not provided.
sourcepub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
Available on crate feature model
only.
pub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
model
only.Edits the GuildWidget
.
Errors
Returns an Error::Http
if the bot does not have the MANAGE_GUILD
permission.
sourcepub async fn get(
http: impl AsRef<Http>,
guild_id: impl Into<GuildId>
) -> Result<PartialGuild>
Available on crate feature model
only.
pub async fn get(
http: impl AsRef<Http>,
guild_id: impl Into<GuildId>
) -> Result<PartialGuild>
model
only.Gets a partial amount of guild data by its Id.
Errors
Returns Error::Http
if the current user is not
in the guild.
sourcepub async fn greater_member_hierarchy(
&self,
cache: impl AsRef<Cache>,
lhs_id: impl Into<UserId>,
rhs_id: impl Into<UserId>
) -> Option<UserId>
Available on crate features model
and cache
only.
pub async fn greater_member_hierarchy(
&self,
cache: impl AsRef<Cache>,
lhs_id: impl Into<UserId>,
rhs_id: impl Into<UserId>
) -> Option<UserId>
model
and cache
only.Returns which of two User
s has a higher Member
hierarchy.
Hierarchy is essentially who has the Role
with the highest
position
.
Returns None
if at least one of the given users’ member instances
is not present. Returns None
if the users have the same hierarchy, as
neither are greater than the other.
If both user IDs are the same, None
is returned. If one of the users
is the guild owner, their ID is returned.
sourcepub async fn member_permissions(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Permissions>
Available on crate features model
and cache
only.
pub async fn member_permissions(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Permissions>
model
and cache
only.Calculate a Member
’s permissions in the guild.
If member caching is enabled the cache will be checked first. If not found it will resort to an http request.
Cache is still required to look up roles.
Errors
See Guild::member
.
sourcepub async fn reorder_channels<It>(
&self,
http: impl AsRef<Http>,
channels: It
) -> Result<()> where
It: IntoIterator<Item = (ChannelId, u64)>,
Available on crate feature model
only.
pub async fn reorder_channels<It>(
&self,
http: impl AsRef<Http>,
channels: It
) -> Result<()> where
It: IntoIterator<Item = (ChannelId, u64)>,
model
only.Re-orders the channels of the guild.
Although not required, you should specify all channels’ positions, regardless of whether they were updated. Otherwise, positioning can sometimes get weird.
Note: Requires the Manage Channels permission.
Errors
Returns an Error::Http
if the current user is lacking permission.
sourcepub async fn search_members(
&self,
http: impl AsRef<Http>,
query: &str,
limit: Option<u64>
) -> Result<Vec<Member>>
Available on crate feature model
only.
pub async fn search_members(
&self,
http: impl AsRef<Http>,
query: &str,
limit: Option<u64>
) -> Result<Vec<Member>>
model
only.Returns a list of Member
s in a Guild
whose username or nickname
starts with a provided string.
Optionally pass in the limit
to limit the number of results.
Minimum value is 1, maximum and default value is 1000.
Note: Queries are case insensitive.
Errors
Returns an Error::Http
if the API returns an error.
sourcepub async fn start_prune(
&self,
cache_http: impl CacheHttp,
days: u16
) -> Result<GuildPrune>
Available on crate feature model
only.
pub async fn start_prune(
&self,
cache_http: impl CacheHttp,
days: u16
) -> Result<GuildPrune>
model
only.Starts a prune of Member
s.
See the documentation on GuildPrune
for more information.
Note: Requires the Kick Members permission.
Errors
If the cache
is enabled, returns a ModelError::InvalidPermissions
if the current user does not have permission to kick members.
Otherwise will return Error::Http
if the current user does not have
permission.
Can also return an Error::Json
if there is an error deserializing
the API response.
sourcepub async fn kick(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
Available on crate feature model
only.
pub async fn kick(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
model
only.Kicks a Member
from the guild.
Requires the Kick Members permission.
Errors
Returns Error::Http
if the member cannot be kicked
by the current user.
sourcepub async fn kick_with_reason(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
reason: &str
) -> Result<()>
Available on crate feature model
only.
pub async fn kick_with_reason(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
reason: &str
) -> Result<()>
model
only.Errors
In addition to the reasons Self::kick
may return an error,
can also return an error if the reason is too long.
sourcepub fn icon_url(&self) -> Option<String>
Available on crate feature model
only.
pub fn icon_url(&self) -> Option<String>
model
only.Returns a formatted URL of the guild’s icon, if the guild has an icon.
Available on crate feature model
only.
model
only.Returns a formatted URL of the guild’s banner, if the guild has a banner.
sourcepub async fn emojis(&self, http: impl AsRef<Http>) -> Result<Vec<Emoji>>
Available on crate feature model
only.
pub async fn emojis(&self, http: impl AsRef<Http>) -> Result<Vec<Emoji>>
model
only.sourcepub async fn emoji(
&self,
http: impl AsRef<Http>,
emoji_id: EmojiId
) -> Result<Emoji>
Available on crate feature model
only.
pub async fn emoji(
&self,
http: impl AsRef<Http>,
emoji_id: EmojiId
) -> Result<Emoji>
model
only.Gets an Emoji
of this guild by its ID via HTTP.
Errors
Returns Error::Http
if an Emoji
with the given Id does
not exist for the guild.
sourcepub async fn integrations(
&self,
http: impl AsRef<Http>
) -> Result<Vec<Integration>>
Available on crate feature model
only.
pub async fn integrations(
&self,
http: impl AsRef<Http>
) -> Result<Vec<Integration>>
model
only.Gets all integration of the guild.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn invites(&self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>>
Available on crate feature model
only.
pub async fn invites(&self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>>
model
only.Gets all of the guild’s invites.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub async fn leave(&self, http: impl AsRef<Http>) -> Result<()>
Available on crate feature model
only.
pub async fn leave(&self, http: impl AsRef<Http>) -> Result<()>
model
only.Leaves the guild.
Errors
Returns Error::Http
if the current user is unable to
leave the Guild, or currently is not in the guild.
sourcepub async fn member(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Member>
Available on crate feature model
only.
pub async fn member(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Member>
model
only.Gets a user’s Member
for the guild by Id.
Errors
Returns Error::Http
if the member is not in the Guild,
or if the Guild is otherwise unavailable.
sourcepub async fn members(
&self,
http: impl AsRef<Http>,
limit: Option<u64>,
after: impl Into<Option<UserId>>
) -> Result<Vec<Member>>
Available on crate feature model
only.
pub async fn members(
&self,
http: impl AsRef<Http>,
limit: Option<u64>,
after: impl Into<Option<UserId>>
) -> Result<Vec<Member>>
model
only.Gets a list of the guild’s members.
Optionally pass in the limit
to limit the number of results.
Minimum value is 1, maximum and default value is 1000.
Optionally pass in after
to offset the results by a User
’s Id.
Errors
Returns an Error::Http
if the API returns an error,
may also return Error::NotInRange
if the input is
not within range.
sourcepub async fn move_member(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
channel_id: impl Into<ChannelId>
) -> Result<Member>
Available on crate feature model
only.
pub async fn move_member(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
channel_id: impl Into<ChannelId>
) -> Result<Member>
model
only.Moves a member to a specific voice channel.
Requires the Move Members permission.
Errors
Returns an Error::Http
if the current user lacks permission,
or if the member is not currently in a voice channel for this Guild.
sourcepub fn user_permissions_in(
&self,
channel: &GuildChannel,
member: &Member
) -> Result<Permissions>
Available on crate feature model
only.
pub fn user_permissions_in(
&self,
channel: &GuildChannel,
member: &Member
) -> Result<Permissions>
model
only.Calculate a Member
’s permissions in a given channel in the guild.
Errors
Returns Error::Model
if the Member has a non-existent Role
for some reason.
sourcepub fn role_permissions_in(
&self,
channel: &GuildChannel,
role: &Role
) -> Result<Permissions>
Available on crate feature model
only.
pub fn role_permissions_in(
&self,
channel: &GuildChannel,
role: &Role
) -> Result<Permissions>
model
only.sourcepub async fn prune_count(
&self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
Available on crate feature model
only.
pub async fn prune_count(
&self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
model
only.Gets the number of Member
s that would be pruned with the given
number of days.
Requires the Kick Members permission.
See Guild::prune_count
.
Errors
Returns Error::Http
if the current user lacks permission.
sourcepub fn shard_id(&self, cache: impl AsRef<Cache>) -> u64
Available on crate features cache
and utils
and model
only.
pub fn shard_id(&self, cache: impl AsRef<Cache>) -> u64
cache
and utils
and model
only.Returns the Id of the shard associated with the guild.
When the cache is enabled this will automatically retrieve the total number of shards.
Note: When the cache is enabled, this function unlocks the cache to
retrieve the total number of shards in use. If you already have the
total, consider using utils::shard_id
.
sourcepub fn splash_url(&self) -> Option<String>
Available on crate feature model
only.
pub fn splash_url(&self) -> Option<String>
model
only.Returns the formatted URL of the guild’s splash image, if one exists.
sourcepub async fn start_integration_sync(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
Available on crate feature model
only.
pub async fn start_integration_sync(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
model
only.Starts an integration sync for the given integration Id.
Requires the Manage Guild permission.
Errors
sourcepub async fn unban(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
Available on crate feature model
only.
pub async fn unban(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
model
only.sourcepub async fn vanity_url(&self, http: impl AsRef<Http>) -> Result<String>
Available on crate feature model
only.
pub async fn vanity_url(&self, http: impl AsRef<Http>) -> Result<String>
model
only.Retrieve’s the guild’s vanity URL.
Note: Requires the Manage Guild permission.
Errors
See Guild::vanity_url
.
sourcepub async fn webhooks(&self, http: impl AsRef<Http>) -> Result<Vec<Webhook>>
Available on crate feature model
only.
pub async fn webhooks(&self, http: impl AsRef<Http>) -> Result<Vec<Webhook>>
model
only.Retrieves the guild’s webhooks.
Note: Requires the Manage Webhooks permission.
Errors
See Guild::webhooks
.
sourcepub fn role_by_name(&self, role_name: &str) -> Option<&Role>
Available on crate feature model
only.
pub fn role_by_name(&self, role_name: &str) -> Option<&Role>
model
only.Obtain a reference to a role by its name.
Note: If two or more roles have the same name, obtained reference will be one of them.
Examples
Obtain a reference to a Role
by its name.
use serenity::model::prelude::*;
use serenity::prelude::*;
struct Handler;
#[serenity::async_trait]
impl EventHandler for Handler {
async fn message(&self, context: Context, msg: Message) {
if let Some(guild_id) = msg.guild_id {
if let Some(guild) = guild_id.to_guild_cached(&context) {
if let Some(role) = guild.role_by_name("role_name") {
println!("Obtained role's reference: {:?}", role);
}
}
}
}
}
let mut client =
Client::builder("token", GatewayIntents::default()).event_handler(Handler).await?;
client.start().await?;
sourcepub fn await_reply(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> CollectReplyⓘNotable traits for CollectReplyimpl Future for CollectReply type Output = Option<Arc<Message>>;
Available on crate features model
and collector
only.
pub fn await_reply(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> CollectReplyⓘNotable traits for CollectReplyimpl Future for CollectReply type Output = Option<Arc<Message>>;
model
and collector
only.Returns a future that will await one message sent in this guild.
sourcepub fn await_replies(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> MessageCollectorBuilder
Available on crate features model
and collector
only.
pub fn await_replies(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> MessageCollectorBuilder
model
and collector
only.Returns a stream builder which can be awaited to obtain a stream of messages in this guild.
sourcepub fn await_reaction(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> CollectReactionⓘNotable traits for CollectReactionimpl Future for CollectReaction type Output = Option<Arc<ReactionAction>>;
Available on crate features model
and collector
only.
pub fn await_reaction(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> CollectReactionⓘNotable traits for CollectReactionimpl Future for CollectReaction type Output = Option<Arc<ReactionAction>>;
model
and collector
only.Await a single reaction in this guild.
sourcepub fn await_reactions(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> ReactionCollectorBuilder
Available on crate features model
and collector
only.
pub fn await_reactions(
&self,
shard_messenger: impl AsRef<ShardMessenger>
) -> ReactionCollectorBuilder
model
and collector
only.Returns a stream builder which can be awaited to obtain a stream of reactions sent in this guild.
sourcepub async fn get_active_threads(
&self,
http: impl AsRef<Http>
) -> Result<ThreadsData>
Available on crate feature model
only.
pub async fn get_active_threads(
&self,
http: impl AsRef<Http>
) -> Result<ThreadsData>
model
only.Gets the guild active threads.
Errors
Returns Error::Http
if there is an error in the deserialization, or
if the bot issuing the request is not in the guild.
Trait Implementations
sourceimpl Clone for PartialGuild
impl Clone for PartialGuild
sourcefn clone(&self) -> PartialGuild
fn clone(&self) -> PartialGuild
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PartialGuild
impl Debug for PartialGuild
sourceimpl<'de> Deserialize<'de> for PartialGuild
impl<'de> Deserialize<'de> for PartialGuild
sourcefn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> StdResult<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> StdResult<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<'a> From<&'a PartialGuild> for GuildId
impl<'a> From<&'a PartialGuild> for GuildId
sourcefn from(guild: &PartialGuild) -> GuildId
fn from(guild: &PartialGuild) -> GuildId
Gets the Id of a partial guild.
sourceimpl From<Guild> for PartialGuild
impl From<Guild> for PartialGuild
sourcefn from(guild: Guild) -> Self
fn from(guild: Guild) -> Self
Converts this Guild
instance into a PartialGuild
PartialGuild
is not a strict subset and contains some data specific to the current user
that Guild
does not contain. Therefore, this method needs access to cache and HTTP to
generate the missing data
sourceimpl From<PartialGuild> for GuildContainer
impl From<PartialGuild> for GuildContainer
sourcefn from(guild: PartialGuild) -> GuildContainer
fn from(guild: PartialGuild) -> GuildContainer
Converts to this type from the input type.
sourceimpl From<PartialGuild> for GuildId
impl From<PartialGuild> for GuildId
sourcefn from(guild: PartialGuild) -> GuildId
fn from(guild: PartialGuild) -> GuildId
Gets the Id of a partial guild.
sourceimpl Serialize for PartialGuild
impl Serialize for PartialGuild
Auto Trait Implementations
impl RefUnwindSafe for PartialGuild
impl Send for PartialGuild
impl Sync for PartialGuild
impl Unpin for PartialGuild
impl UnwindSafe for PartialGuild
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