Struct serenity::utils::builder::CreateInvite

pub struct CreateInvite(pub ObjectBuilder);

A builder to create a RichInvite for use via Context::create_invite.

This is a structured and cleaner way of creating an invite, as all parameters are optional.

Examples

Create an invite with a max age of 3600 seconds and 10 max uses:

use serenity::Client;
use std::env;

let mut client = Client::login_bot(&env::var("DISCORD_BOT_TOKEN").unwrap());

client.on_message(|context, message| {
    if message.content == "!invite" {
        let invite = context.create_invite(message.channel_id, |i| i
            .max_age(3600)
            .max_uses(10));
    }
});

Methods

impl CreateInvite

fn max_age(self, max_age: u64) -> Self

The duration that the invite will be valid for.

Set to 0 for an invite which does not expire after an amount of time.

Defaults to 86400, or 24 hours.

fn max_uses(self, max_uses: u64) -> Self

The number of uses that the invite will be valid for.

Set to 0 for an invite which does not expire after a number of uses.

Defaults to 0.

fn temporary(self, temporary: bool) -> Self

Whether an invite grants a temporary membership.

Defaults to false.

fn unique(self, unique: bool) -> Self

Whether or not to try to reuse a similar invite.

Defaults to false.

Trait Implementations

impl Default for CreateInvite

fn default() -> CreateInvite

Creates a builder with default values, setting validate to null.