Struct serenity::model::id::GuildId [−][src]
pub struct GuildId(pub u64);
Expand description
An identifier for a Guild
Tuple Fields
0: u64
Implementations
Ban a User
from the guild, deleting a number of
days’ worth of messages (dmd
) between the range 0 and 7.
Refer to the documentation for Guild::ban
for more information.
Note: Requires the Ban Members permission.
Examples
Ban a member and remove all messages they’ve sent in the last 4 days:
use serenity::model::id::GuildId;
use serenity::model::id::UserId;
// assuming a `user` has already been bound
let _ = GuildId(81384788765712384).ban(&http, user, 4).await;
Errors
Returns a ModelError::DeleteMessageDaysAmount
if the number of
days’ worth of messages to delete is over the maximum.
Also can return Error::Http
if the current user lacks permission.
Ban a User
from the guild with a reason. Refer to Self::ban
to further documentation.
Errors
In addition to the reasons Self::ban
may return an error, may
also return Error::ExceededLimit
if reason
is too long.
Gets a list of the guild’s bans.
Note: Requires the Ban Members permission.
Errors
Returns Error::Http
if the current user lacks permission.
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.
Gets all of the guild’s channels over the REST API.
Errors
Returns Error::Http
if the current user is not in
the guild.
pub async fn create_channel(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
pub async fn create_channel(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
Creates a GuildChannel
in the 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::channel::ChannelType;
use serenity::model::id::GuildId;
let _channel =
GuildId(7).create_channel(&http, |c| c.name("test").kind(ChannelType::Voice)).await;
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid values are set.
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 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 name is too long, or if the image is too big.
pub async fn create_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
pub async fn create_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
Creates an integration for the guild.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission.
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 invalid data is given.
Deletes the current guild if the current account is the owner of the guild.
Refer to Guild::delete
for more information.
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.
Deletes an Emoji
from the guild.
Note: Requires the Manage Emojis permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an Emoji with that Id does not exist.
pub async fn delete_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
pub async fn delete_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
Deletes an integration by Id from the guild.
Note: 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.
Deletes a Role
by Id from the guild.
Also see Role::delete
if you have the cache
and model
features
enabled.
Note: 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.
Edits the current guild with new data where specified.
Refer to Guild::edit
for more information.
Note: Requires the current user to have the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an invalid value is set.
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 permission.
Errors
Returns Error::Http
if the current user lacks permission.
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,
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,
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:
guild.edit_member(&context, user_id, |m| m.mute(true).roles(&vec![role_id]));
Errors
Returns Error::Http
if the current user lacks the necessary permissions.
Edits the current user’s nickname for the guild.
Pass None
to reset the nickname.
Requires the Change Nickname permission.
Errors
Returns Error::Http
if the current user lacks permission.
Edits a Role
, optionally setting its new fields.
Requires the Manage Roles permission.
Examples
Make a role hoisted:
use serenity::model::{GuildId, RoleId};
GuildId(7).edit_role(&context, RoleId(8), |r| r.hoist(true));
Errors
Returns Error::Http
if the current user lacks permission.
Edits the order of Role
s
Requires the Manage Roles permission.
Examples
Change the order of a role:
use serenity::model::{GuildId, RoleId};
GuildId(7).edit_role_position(&context, RoleId(8), 2);
Errors
Returns an Error::Http
if the current user lacks permission.
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
Edits the GuildWelcomeScreen
.
Errors
Returns an Error::Http
if some mandatory fields are not provided.
pub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
pub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
Edits the GuildWidget
.
Errors
Returns an Error::Http
if the bot does not have the MANAGE_GUILD
permission.
Gets all of the guild’s roles over the REST API.
Errors
Returns Error::Http
if the current user is not in
the guild.
Tries to find the Guild
by its Id in the cache.
Requests PartialGuild
over REST API.
Note: This will not be a Guild
, as the REST API does not send
all data with a guild retrieval.
Errors
Returns an Error::Http
if the current user is not in the guild.
pub async fn to_partial_guild_with_counts(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
pub async fn to_partial_guild_with_counts(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
Requests PartialGuild
over REST API with counts.
Note: This will not be a Guild
, as the REST API does not send
all data with a guild retrieval.
Errors
Returns an Error::Http
if the current user is not in the guild.
Gets an Emoji
of this guild by its ID via HTTP.
Errors
Returns an Error::Http
if an emoji with that Id does not exist.
Gets all integration of the guild.
Requires the Manage Guild permission.
Errors
Returns an Error::Http
if the current user lacks permission,
also may return Error::Json
if there is an error in deserializing
the API response.
Gets all of the guild’s invites.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
also may return Error::Json
if there is an error in
deserializing the API response.
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.
Errors
In addition to the reasons Self::kick
may return an error,
may also return an error if the reason is too long.
Leaves the guild.
Errors
May return an Error::Http
if the current user
cannot leave the guild, or currently is not in the guild.
Gets a user’s Member
for the guild by Id.
If the cache feature is enabled the cache will be checked first. If not found it will resort to an http request.
Errors
Returns an Error::Http
if the user is not in the guild,
or if the guild is otherwise unavailable
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.
Streams over all the members in a guild.
This is accomplished and equivalent to repeated calls to Self::members
.
A buffer of at most 1,000 members is used to reduce the number of calls
necessary.
Examples
use serenity::futures::StreamExt;
use serenity::model::guild::MembersIter;
let mut members = guild_id.members_iter(&ctx).boxed();
while let Some(member_result) = members.next().await {
match member_result {
Ok(member) => println!("{} is {}", member, member.display_name(),),
Err(error) => eprintln!("Uh oh! Error: {}", error),
}
}
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
.
Returns the name of whatever guild this id holds.
Disconnects a member from a voice channel in the guild.
Requires the Move Members permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if the member is not currently in a voice channel for this guild.
Gets the number of Member
s that would be pruned with the given
number of days.
Requires the Kick Members permission.
Errors
Returns Error::Http
if the current user does not have permission.
Re-orders the channels of the guild.
Accepts an iterator of a tuple of the channel ID to modify and its new position.
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 Error::Http
if the current user lacks permission.
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.
Errors
Returns an Error::Http
if the API returns an error.
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
.
pub async fn start_integration_sync(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
pub async fn start_integration_sync(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
Starts an integration sync for the given integration Id.
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.
Starts a prune of Member
s.
See the documentation on GuildPrune
for more information.
Note: Requires the Kick Members permission.
Errors
Returns Error::Http
if the current user lacks permission.
Unbans a User
from the guild.
Note: Requires the Ban Members permission.
Errors
Returns Error::Http
if the current user does not have permission.
Retrieve’s the guild’s vanity URL.
Note: Requires the Manage Guild permission.
Errors
Will return Error::Http
if the current user lacks permission.
Can also return Error::Json
if there is an error deserializing
the API response.
Retrieves the guild’s webhooks.
Note: Requires the Manage Webhooks permission.
Errors
Will return an Error::Http
if the bot is lacking permissions.
Can also return an Error::Json
if there is an error deserializing
the API response.
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
Creates a guild specific ApplicationCommand
Note: Unlike global ApplicationCommand
s, guild commands will update instantly.
Errors
Returns the same possible errors as create_global_application_command
.
pub async fn set_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommand>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
pub async fn set_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommand>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
Overrides all guild application commands.
Errors
Returns the same possible errors as set_global_application_commands
.
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
Creates a guild specific ApplicationCommandPermission
.
Note: It will update instantly.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn set_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
pub async fn set_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
Overrides all application commands permissions.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommand>>
pub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommand>>
Get all guild application commands.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommand>
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommand>
Get a specific guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
Edit guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
Delete guild application command by its Id.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommandPermission>>
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommandPermission>>
Get all guild application commands permissions only.
Errors
If there is an error, it will be either Error::Http
or Error::Json
.
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommandPermission>
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommandPermission>
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
.
Get the guild welcome screen.
Errors
Returns Error::Http
if the guild does not have a welcome screen.
Get the guild preview.
Note: The bot need either to be part of the guild
or the guild needs to have the DISCOVERABLE
feature.
Errors
Returns Error::Http
if the bot cannot see the guild preview, see the note.
Get the guild widget.
Errors
Returns Error::Http
if the bot does not have MANAGE_MESSAGES
permission.
Get the widget image URL.
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.
Retrieves the time that the Id was created at.
Mutably borrow inner Id.
Trait Implementations
Deserialize this value from the given Serde deserializer. Read more
Gets the Id of Invite Guild struct.
Gets the Id of a partial guild.
Performs the conversion.
Gets the Id of Invite Guild struct.
Gets the Id of a partial guild.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for GuildId
impl UnwindSafe for GuildId
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more