[−][src]Struct serenity::model::invite::RichInvite
Detailed information about an invite.
This information can only be retrieved by anyone with the Manage Guild
permission. Otherwise, a minimal amount of information can be retrieved via
the Invite
struct.
Fields
channel: InviteChannel
A representation of the minimal amount of information needed about the channel being invited to.
code: String
The unique code for the invite.
created_at: DateTime<Utc>
When the invite was created.
guild: Option<InviteGuild>
A representation of the minimal amount of information needed about the
Guild
being invited to.
inviter: User
The user that created the invite.
max_age: u64
The maximum age of the invite in seconds, from when it was created.
max_uses: u64
The maximum number of times that an invite may be used before it expires.
Note that this does not supersede the max_age
value, if the value of
temporary
is true
. If the value of temporary
is false
, then the
invite will self-expire after the given number of max uses.
If the value is 0
, then the invite is permanent.
temporary: bool
Indicator of whether the invite self-expires after a certain amount of time or uses.
uses: u64
The amount of times that an invite has been used.
Implementations
impl RichInvite
[src]
pub async fn delete<'_>(&'_ self, cache_http: impl CacheHttp) -> Result<Invite>
[src]
Deletes the invite.
Refer to Http::delete_invite
for more information.
Note: Requires the Manage Guild permission.
Errors
If the cache
feature is enabled, then this returns a
ModelError::InvalidPermissions
if the current user does not have
the required permission.
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 RichInvite
[src]
fn clone(&self) -> RichInvite
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RichInvite
[src]
impl<'de> Deserialize<'de> for RichInvite
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Serialize for RichInvite
[src]
Auto Trait Implementations
impl RefUnwindSafe for RichInvite
impl Send for RichInvite
impl Sync for RichInvite
impl Unpin for RichInvite
impl UnwindSafe for RichInvite
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
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.
pub 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.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,