Struct serenity::model::RichInvite

pub struct RichInvite {
    pub channel: InviteChannel,
    pub code: String,
    pub created_at: String,
    pub guild: InviteGuild,
    pub inviter: User,
    pub max_age: u64,
    pub max_uses: u64,
    pub temporary: bool,
    pub uses: u64,
}

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 GuildChannel being invited to.

code: String

The unique code for the invite.

created_at: String

When the invite was created.

guild: 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 supercede 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

Whether the invite self-expires after a certain amount of time or uses.

uses: u64

The maximum amount of times that an invite may be used before it self-expires.

Methods

impl RichInvite

fn accept(&self) -> Result<Invite>

Accepts the invite, placing the current user in the Guild that the invite was for.

Refer to rest::accept_invite for more information.

Note: This will fail if you are already in the guild, or are banned. A ban is equivalent to an IP ban.

Note: Requires that the current user be a user account.

Errors

If the cache is enabled, returns a ClientError::InvalidOperationAsBot if the current user is a bot user.

fn delete(&self) -> Result<Invite>

Deletes the invite.

Refer to rest::delete_invite for more information.

Note: Requires the Manage Guild permission.

Errors

If the cache feature is enabled, then this returns a ClientError::InvalidPermissions if the current user does not have the required permission.

Trait Implementations

impl Clone for RichInvite

fn clone(&self) -> RichInvite

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RichInvite

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.