Struct twilight_http::request::scheduled_event::CreateGuildScheduledEvent

pub struct CreateGuildScheduledEvent<'a> { /* private fields */ }

Create a scheduled event in a guild.

Once a guild is selected, you must choose one of three event types to create. The request builders will ensure you provide the correct data to Discord. See [Discord Docs/Create Guild Schedule Event].

The name must be between 1 and 100 characters in length. For external events, the location must be between 1 and 100 characters in length.

Examples

Create an event in a stage instance:

use twilight_model::{id::Id, util::Timestamp};
let guild_id = Id::new(1);
let channel_id = Id::new(2);
let garfield_start_time = Timestamp::parse("2022-01-01T14:00:00+00:00")?;

client
    .create_guild_scheduled_event(guild_id)
    .stage_instance(
        channel_id,
        "Garfield Appreciation Hour",
        &garfield_start_time,
    )?
    .description("Discuss: How important is Garfield to You?")?
    .exec()
    .await?;

Create an external event:

use twilight_model::{id::Id, util::Timestamp};
let guild_id = Id::new(1);
let garfield_con_start_time = Timestamp::parse("2022-01-04T08:00:00+00:00")?;
let garfield_con_end_time = Timestamp::parse("2022-01-06T17:00:00+00:00")?;

client
    .create_guild_scheduled_event(guild_id)
    .external(
        "Garfield Con 2022",
        "Baltimore Convention Center",
        &garfield_con_start_time,
        &garfield_con_end_time,
    )?
    .description(
        "In a spiritual successor to BronyCon, Garfield fans from \
around the globe celebrate all things related to the loveable cat.",
    )?
    .exec()
    .await?;

Implementations

impl<'a> CreateGuildScheduledEvent<'a>

pub fn external(
    self,
    name: &'a str,
    location: &'a str,
    scheduled_start_time: &'a Timestamp,
    scheduled_end_time: &'a Timestamp
) -> Result<CreateGuildExternalScheduledEvent<'a>, ValidationError>

Create an external scheduled event in a guild.

The name must be between 1 and 100 characters in length.

Errors

Returns an error of type ScheduledEventName if the name is invalid.

pub fn stage_instance(
    self,
    channel_id: Id<ChannelMarker>,
    name: &'a str,
    scheduled_start_time: &'a Timestamp
) -> Result<CreateGuildStageInstanceScheduledEvent<'a>, ValidationError>

Create a stage instance scheduled event in a guild.

The name must be between 1 and 100 characters in length.

Errors

Returns an error of type ScheduledEventName if the name is invalid.

pub fn voice(
    self,
    channel_id: Id<ChannelMarker>,
    name: &'a str,
    scheduled_start_time: &'a Timestamp
) -> Result<CreateGuildVoiceScheduledEvent<'a>, ValidationError>

Create a voice channel scheduled event in a guild.

The name must be between 1 and 100 characters in length.

Errors

Returns an error of type ScheduledEventName if the name is invalid.

Trait Implementations

impl<'a> AuditLogReason<'a> for CreateGuildScheduledEvent<'a>

fn reason(self, reason: &'a str) -> Result<Self, ValidationError>

Attach an audit log reason to the request.

impl TryIntoRequest for CreateGuildScheduledEvent<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.