Struct twilight_http::request::guild::create_guild::CreateGuild

pub struct CreateGuild<'a> { /* fields omitted */ }

Create a new request to create a guild.

The minimum length of the name is 2 UTF-16 characters and the maximum is 100 UTF-16 characters. This endpoint can only be used by bots in less than 10 guilds.

Implementations

impl<'a> CreateGuild<'a>

pub fn add_role(self, role: impl Into<RoleFields>) -> Self

Add a role to the list of roles.

pub fn afk_channel_id(self, afk_channel_id: ChannelId) -> Self

Set the ID of the AFK voice channel.

This must be an ID specified in channels.

pub fn afk_timeout(self, afk_timeout: u64) -> Self

Set the AFK timeout, in seconds.

pub fn channels(
    self,
    channels: Vec<GuildChannelFields>
) -> Result<Self, CreateGuildError>

Set the channels to create with the guild.

The maximum number of channels that can be provided is 500.

Examples

use twilight_http::{
    Client,
    request::guild::create_guild::{
        GuildChannelFieldsBuilder, CategoryFieldsBuilder, TextFieldsBuilder,
        VoiceFieldsBuilder,
    },
};

let text = TextFieldsBuilder::new("text channel")?;
let voice = VoiceFieldsBuilder::new("voice channel")?;
let text2 = TextFieldsBuilder::new("other text channel")?
    .topic("posting")?;

let category = CategoryFieldsBuilder::new("category channel")?
    .add_text(text2)
    .add_voice(voice);

let channels = GuildChannelFieldsBuilder::new()
    .add_text(text)
    .add_category_builder(category)
    .build();

let guild = client.create_guild("guild name")?.channels(channels)?.await?;

Errors

Returns a CreateGuildErrorType::TooManyChannels error type if the number of channels is over 500.

pub fn default_message_notifications(
    self,
    default_message_notifications: DefaultMessageNotificationLevel
) -> Self

Set the default message notification level. Refer to the discord docs for more information.

pub fn explicit_content_filter(
    self,
    explicit_content_filter: ExplicitContentFilter
) -> Self

Set the explicit content filter level.

pub fn icon(self, icon: impl Into<String>) -> Self

Set the icon.

This must be a Data URI, in the form of data:image/{type};base64,{data} where {type} is the image MIME type and {data} is the base64-encoded image. Refer to the discord docs for more information.

pub fn override_everyone(self, everyone: impl Into<RoleFields>) -> Self

Override the everyone role of the guild.

If there are not yet roles set with roles, this will create a role override in the first position. Discord understands the first role in the list to override @everyone. If there are roles, this replaces the first role in the position.

pub fn system_channel_id(self, system_channel_id: ChannelId) -> Self

Set the channel where system messages will be posted.

This must be an ID specified in channels.

pub fn system_channel_flags(
    self,
    system_channel_flags: SystemChannelFlags
) -> Self

Set the guild’s SystemChannelFlags.

pub fn roles(self, roles: Vec<RoleFields>) -> Result<Self, CreateGuildError>

Set the roles to create with the guild.

The maximum number of roles that can be provided is 250.

Examples

use twilight_http::{Client, request::guild::create_guild::RoleFieldsBuilder};

let roles = vec![RoleFieldsBuilder::new("role 1").color(0x543923)?.build()];
client.create_guild("guild name")?.roles(roles)?.await?;

Errors

Returns a CreateGuildErrorType::TooManyRoles error type if the number of roles is over 250.

Trait Implementations

impl Future for CreateGuild<'_>

type Output = Result<PartialGuild, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.