[−][src]Struct serenity::model::invite::Invite
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]
pub fn create<C, F>(
cache_http: impl CacheHttp,
channel_id: C,
f: F
) -> Result<RichInvite> where
C: Into<ChannelId>,
F: FnOnce(CreateInvite) -> CreateInvite,
[src]
cache_http: impl CacheHttp,
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, cache_http: impl CacheHttp) -> Result<Invite>
[src]
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(http: impl AsRef<Http>, code: &str, stats: bool) -> Result<Invite>
[src]
Gets the information about an invite.
pub fn url(&self) -> String
[src]
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]
fn clone(&self) -> Invite
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for Invite
[src]
impl Serialize for Invite
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for Invite
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Send for Invite
impl Unpin for Invite
impl Sync for Invite
impl UnwindSafe for Invite
impl RefUnwindSafe for Invite
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Erased for T
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> DebugAny for T where
T: Any + Debug,
[src]
T: Any + Debug,
impl<T> CloneAny for T where
T: Clone + Any,
[src]
T: Clone + Any,
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
[src]
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
[src]
T: Send,
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
[src]
T: Sync,
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
[src]
T: Send + Sync,
impl<T> UnsafeAny for T where
T: Any,
T: Any,