Struct EditScheduledEvent

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

Discord docs

Implementations

impl<'a> EditScheduledEvent<'a>

pub fn new() -> Self

Equivalent to Self::default.

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

Sets the channel id of the scheduled event. If the kind of the event is changed from External to either StageInstance or Voice, then this field is also required.

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

Sets the name of the scheduled event.

pub fn privacy_level(self, privacy_level: ScheduledEventPrivacyLevel) -> Self

The privacy level of the scheduled event

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.

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

Sets the end time of the scheduled event.

If the kind of the event is changed to External, then this field is also required.

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

Sets the entity type of the scheduled event.

If changing to External, then end_time and location must also be set. Otherwise, if changing to either StageInstance or Voice, then channel_id is also required to be set.

See the Discord docs for more details.

pub fn status(self, status: ScheduledEventStatus) -> Self

Sets the status of the scheduled event.

Only the following transitions are valid:

Scheduled -> Active

Active -> Completed

Scheduled -> Canceled

Additionally, if the event’s status is Completed or Canceled, then it can no longer be updated.

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

Sets the location of the scheduled event.

If the kind of the event is changed to External, then this field is also required to be set and non-empty.

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 EditScheduledEvent<'_>

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,

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

Note: If the event was created by the current user, requires either Create Events or the Manage Events permission. Otherwise, the Manage Events permission is required.

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, ScheduledEventId)

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

type Built = ScheduledEvent

impl<'a> Clone for EditScheduledEvent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EditScheduledEvent<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EditScheduledEvent<'a>

fn default() -> EditScheduledEvent<'a>

Returns the “default value” for a type.

impl<'a> Serialize for EditScheduledEvent<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.