Struct CreateScheduledEvent

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

Available on crate feature builder only.

Discord docs

Implementations

impl<'a> CreateScheduledEvent<'a>

pub fn new( kind: ScheduledEventType, name: impl Into<String>, scheduled_start_time: impl Into<Timestamp>, ) -> Self

Creates a builder with the provided kind, name, and start time, leaving all other fields empty.

pub fn channel_id<C: Into<ChannelId>>(self, channel_id: C) -> Self

Sets the channel id of the scheduled event. Required if Self::kind is ScheduledEventType::StageInstance or ScheduledEventType::Voice.

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

Sets the name of the scheduled event, replacing the current value as set in Self::new.

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

Sets the description of the scheduled event.

pub fn start_time(self, timestamp: impl Into<Timestamp>) -> Self

Sets the start time of the scheduled event, replacing the current value as set in Self::new.

pub fn end_time(self, timestamp: impl Into<Timestamp>) -> Self

Sets the end time of the scheduled event. Required if Self::kind is ScheduledEventType::External.

pub fn kind(self, kind: ScheduledEventType) -> Self

Sets the entity type of the scheduled event, replacing the current value as set in Self::new.

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

Sets the location of the scheduled event. Required to be set and non-empty if Self::kind is ScheduledEventType::External.

pub fn image(self, image: &CreateAttachment) -> Self

Sets the cover image for the scheduled event.

pub fn audit_log_reason(self, reason: &'a str) -> Self

Sets the request’s audit log reason.

Trait Implementations

impl Builder for CreateScheduledEvent<'_>

Available on crate feature http only.

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new scheduled event in the guild with the data set, if any.

Note: Requires the Create Events permission.

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user lacks permission. Otherwise returns Error::Http, as well as if invalid data is given.

type Context<'ctx> = GuildId

Additional data that’s only required when sending a request off to the API.

type Built = ScheduledEvent

impl<'a> Clone for CreateScheduledEvent<'a>

fn clone(&self) -> CreateScheduledEvent<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateScheduledEvent<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Serialize for CreateScheduledEvent<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.