Struct serenity::model::GuildId
[−]
[src]
pub struct GuildId(pub u64);
An identifier for a Guild
Methods
impl GuildId
[src]
fn as_channel_id(&self) -> ChannelId
[src]
: The concept of default channels is no more, use Guild::default_channel{_guaranteed}
to simulate the
concept.
Converts the guild Id into the default channel's Id.
fn ban<U: Into<UserId>, BO: BanOptions>(
&self,
user: U,
ban_options: BO
) -> Result<()>
[src]
&self,
user: U,
ban_options: BO
) -> Result<()>
Ban a User
from the guild. All messages by the
user within the last given number of days given will be deleted.
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::GuildId; // assuming a `user` has already been bound let _ = GuildId(81384788765712384).ban(user, 4);
Errors
Returns a ModelError::DeleteMessageDaysAmount
if the number of
days' worth of messages to delete is over the maximum.
fn bans(&self) -> Result<Vec<Ban>>
[src]
Gets a list of the guild's bans.
Requires the Ban Members permission.
fn audit_logs(&self) -> Result<AuditLogs>
[src]
Gets a list of the guild's audit log entries
fn channels(&self) -> Result<HashMap<ChannelId, GuildChannel>>
[src]
Gets all of the guild's channels over the REST API.
fn create_channel(&self, name: &str, kind: ChannelType) -> Result<GuildChannel>
[src]
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::{ChannelType, GuildId}; let _channel = GuildId(7).create_channel("test", ChannelType::Voice);
fn create_emoji(&self, name: &str, image: &str) -> Result<Emoji>
[src]
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.
fn create_integration<I>(&self, integration_id: I, kind: &str) -> Result<()> where
I: Into<IntegrationId>,
[src]
I: Into<IntegrationId>,
Creates an integration for the guild.
Requires the Manage Guild permission.
fn create_role<F: FnOnce(EditRole) -> EditRole>(&self, f: F) -> Result<Role>
[src]
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.
fn delete(&self) -> Result<PartialGuild>
[src]
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.
fn delete_emoji<E: Into<EmojiId>>(&self, emoji_id: E) -> Result<()>
[src]
Deletes an Emoji
from the guild.
Requires the Manage Emojis permission.
fn delete_integration<I: Into<IntegrationId>>(
&self,
integration_id: I
) -> Result<()>
[src]
&self,
integration_id: I
) -> Result<()>
Deletes an integration by Id from the guild.
Requires the Manage Guild permission.
fn delete_role<R: Into<RoleId>>(&self, role_id: R) -> Result<()>
[src]
Deletes a Role
by Id from the guild.
Also see Role::delete
if you have the cache
and methods
features
enabled.
Requires the Manage Roles permission.
fn edit<F: FnOnce(EditGuild) -> EditGuild>(
&mut self,
f: F
) -> Result<PartialGuild>
[src]
&mut self,
f: F
) -> Result<PartialGuild>
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.
fn edit_emoji<E: Into<EmojiId>>(&self, emoji_id: E, name: &str) -> Result<Emoji>
[src]
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.
fn edit_member<F, U>(&self, user_id: U, f: F) -> Result<()> where
F: FnOnce(EditMember) -> EditMember,
U: Into<UserId>,
[src]
F: FnOnce(EditMember) -> EditMember,
U: Into<UserId>,
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(user_id, |m| m.mute(true).roles(&vec![role_id]));
fn edit_nickname(&self, new_nickname: Option<&str>) -> Result<()>
[src]
Edits the current user's nickname for the guild.
Pass None
to reset the nickname.
Requires the Change Nickname permission.
fn edit_role<F, R>(&self, role_id: R, f: F) -> Result<Role> where
F: FnOnce(EditRole) -> EditRole,
R: Into<RoleId>,
[src]
F: FnOnce(EditRole) -> EditRole,
R: Into<RoleId>,
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(RoleId(8), |r| r.hoist(true));
fn find(&self) -> Option<Arc<RwLock<Guild>>>
[src]
Search the cache for the guild.
fn get(&self) -> Result<PartialGuild>
[src]
Requests the guild over REST.
Note that this will not be a complete guild, as REST does not send all data with a guild retrieval.
fn integrations(&self) -> Result<Vec<Integration>>
[src]
Gets all integration of the guild.
This performs a request over the REST API.
fn invites(&self) -> Result<Vec<RichInvite>>
[src]
Gets all of the guild's invites.
Requires the Manage Guild permission.
fn kick<U: Into<UserId>>(&self, user_id: U) -> Result<()>
[src]
Kicks a Member
from the guild.
Requires the Kick Members permission.
fn leave(&self) -> Result<()>
[src]
Leaves the guild.
fn member<U: Into<UserId>>(&self, user_id: U) -> Result<Member>
[src]
Gets a user's Member
for the guild by Id.
fn members<U>(
&self,
limit: Option<u64>,
after: Option<U>
) -> Result<Vec<Member>> where
U: Into<UserId>,
[src]
&self,
limit: Option<u64>,
after: Option<U>
) -> Result<Vec<Member>> where
U: Into<UserId>,
Gets a list of the guild's members.
Optionally pass in the limit
to limit the number of results. Maximum
value is 1000. Optionally pass in after
to offset the results by a
User
's Id.
fn move_member<C, U>(&self, user_id: U, channel_id: C) -> Result<()> where
C: Into<ChannelId>,
U: Into<UserId>,
[src]
C: Into<ChannelId>,
U: Into<UserId>,
Moves a member to a specific voice channel.
Requires the Move Members permission.
fn prune_count(&self, days: u16) -> Result<GuildPrune>
[src]
Gets the number of Member
s that would be pruned with the given
number of days.
Requires the Kick Members permission.
[src]
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
.
fn start_integration_sync<I: Into<IntegrationId>>(
&self,
integration_id: I
) -> Result<()>
[src]
&self,
integration_id: I
) -> Result<()>
Starts an integration sync for the given integration Id.
Requires the Manage Guild permission.
fn start_prune(&self, days: u16) -> Result<GuildPrune>
[src]
Starts a prune of Member
s.
See the documentation on GuildPrune
for more information.
Note: Requires the Kick Members permission.
fn unban<U: Into<UserId>>(&self, user_id: U) -> Result<()>
[src]
Unbans a User
from the guild.
Requires the Ban Members permission.
fn webhooks(&self) -> Result<Vec<Webhook>>
[src]
Retrieves the guild's webhooks.
Note: Requires the Manage Webhooks permission.
impl GuildId
[src]
fn created_at(&self) -> NaiveDateTime
[src]
Retrieves the time that the Id was created at.
Trait Implementations
impl From<PartialGuild> for GuildId
[src]
fn from(guild: PartialGuild) -> GuildId
[src]
Gets the Id of a partial guild.
impl<'a> From<&'a PartialGuild> for GuildId
[src]
fn from(guild: &PartialGuild) -> GuildId
[src]
Gets the Id of a partial guild.
impl From<GuildInfo> for GuildId
[src]
impl<'a> From<&'a GuildInfo> for GuildId
[src]
impl From<InviteGuild> for GuildId
[src]
fn from(invite_guild: InviteGuild) -> GuildId
[src]
Gets the Id of Invite Guild struct.
impl<'a> From<&'a InviteGuild> for GuildId
[src]
fn from(invite_guild: &InviteGuild) -> GuildId
[src]
Gets the Id of Invite Guild struct.
impl From<Guild> for GuildId
[src]
impl<'a> From<&'a Guild> for GuildId
[src]
impl Copy for GuildId
[src]
impl Clone for GuildId
[src]
fn clone(&self) -> GuildId
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for GuildId
[src]
impl Eq for GuildId
[src]
impl Hash for GuildId
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialOrd for GuildId
[src]
fn partial_cmp(&self, __arg_0: &GuildId) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &GuildId) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &GuildId) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &GuildId) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &GuildId) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for GuildId
[src]
fn cmp(&self, __arg_0: &GuildId) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.22.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.22.0[src]
Compares and returns the minimum of two values. Read more
impl From<u64> for GuildId
[src]
impl PartialEq for GuildId
[src]
fn eq(&self, other: &Self) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<u64> for GuildId
[src]
fn eq(&self, u: &u64) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl Display for GuildId
[src]
fn fmt(&self, f: &mut Formatter) -> FmtResult
[src]
Formats the value using the given formatter. Read more
impl<'de> Deserialize<'de> for GuildId
[src]
fn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> StdResult<Self, D::Error>
[src]
deserializer: D
) -> StdResult<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more