Struct serenity::model::invite::Invite [−][src]
pub struct Invite { pub approximate_member_count: Option<u64>, pub approximate_presence_count: Option<u64>, pub code: String, pub channel: InviteChannel, pub guild: Option<InviteGuild>, }
Information about an invite code.
Information can not be accessed for guilds the current user is banned from.
Fields
approximate_member_count: Option<u64>
approximate_presence_count: Option<u64>
The approximate number of Member
s with an active session in the
related Guild
.
An active session is defined as an open, heartbeating WebSocket connection. These include invisible members.
code: String
The unique code for the invite.
channel: InviteChannel
A representation of the minimal amount of information needed about the
GuildChannel
being invited to.
guild: Option<InviteGuild>
A representation of the minimal amount of information needed about the
Guild
being invited to.
This can be None
if the invite is to a Group
and not to a
Guild.
Methods
impl Invite
[src]
impl Invite
pub fn create<C, F>(channel_id: C, f: F) -> Result<RichInvite> where
C: Into<ChannelId>,
F: FnOnce(CreateInvite) -> CreateInvite,
[src]
pub fn create<C, F>(channel_id: C, f: F) -> Result<RichInvite> where
C: Into<ChannelId>,
F: FnOnce(CreateInvite) -> CreateInvite,
Creates an invite for a GuildChannel
, providing a builder so that
fields may optionally be set.
See the documentation for the CreateInvite
builder for information
on how to use this and the default values that it provides.
Requires the Create Invite permission.
Errors
If the cache
is enabled, returns a ModelError::InvalidPermissions
if the current user does not have the required permission.
pub fn delete(&self) -> Result<Invite>
[src]
pub fn delete(&self) -> Result<Invite>
Deletes the invite.
Note: Requires the Manage Guild permission.
Errors
If the cache
is enabled, returns a ModelError::InvalidPermissions
if the current user does not have the required permission.
pub fn get(code: &str, stats: bool) -> Result<Invite>
[src]
pub fn get(code: &str, stats: bool) -> Result<Invite>
Gets the information about an invite.
pub fn url(&self) -> String
[src]
pub fn url(&self) -> String
Returns a URL to use for the invite.
Examples
Retrieve the URL for an invite with the code WxZumR
:
assert_eq!(invite.url(), "https://discord.gg/WxZumR");
Trait Implementations
impl Clone for Invite
[src]
impl Clone for Invite
fn clone(&self) -> Invite
[src]
fn clone(&self) -> Invite
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for Invite
[src]
impl Debug for Invite