Struct serenity::builder::EditScheduledEvent

pub struct EditScheduledEvent(pub HashMap<&'static str, Value>);

Available on crate feature builder only.

Tuple Fields

0: HashMap<&'static str, Value>

Implementations

impl EditScheduledEvent

pub fn channel_id<C: Into<ChannelId>>(&mut self, channel_id: C) -> &mut 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<S: ToString>(&mut self, name: S) -> &mut Self

Sets the name of the scheduled event.

pub fn description<S: ToString>(&mut self, description: S) -> &mut Self

Sets the description of the scheduled event.

pub fn start_time<T: Into<Timestamp>>(&mut self, timestamp: T) -> &mut Self

Sets the start time of the scheduled event.

pub fn end_time<T: Into<Timestamp>>(&mut self, timestamp: T) -> &mut 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(&mut self, kind: ScheduledEventType) -> &mut 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.

pub fn status(&mut self, status: ScheduledEventStatus) -> &mut 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<S: ToString>(&mut self, location: S) -> &mut 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 async fn image<'a>(
    &mut self,
    http: impl AsRef<Http>,
    image: impl Into<AttachmentType<'a>>
) -> Result<&mut Self>

Available on crate feature model only.

Sets the cover image for the scheduled event.

Errors

May error if the icon is a URL and the HTTP request fails, or if the image is a file on a path that doesn’t exist.

Trait Implementations

impl Clone for EditScheduledEvent

fn clone(&self) -> EditScheduledEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditScheduledEvent

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

Formats the value using the given formatter.

impl Default for EditScheduledEvent

fn default() -> EditScheduledEvent

Returns the “default value” for a type.