Struct twilight_http::request::scheduled_event::UpdateGuildScheduledEvent

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

Update a scheduled event in a guild.

This endpoint supports changing the type of event. When changing the entity type to either EntityType::StageInstance or EntityType::Voice, an Id<ChannelMarker> must be provided if it does not already exist.

When changing the entity type to EntityType::External, the channel_id field is cleared and the channel_id method has no effect. Additionally, you must set a location with location.

Implementations

impl<'a> UpdateGuildScheduledEvent<'a>

pub fn channel_id(self, channel_id: Id<ChannelMarker>) -> Self

Set the channel ID.

If entity_type is already EntityType::External, this has no effect.

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

Set the description of the event.

Must be between 1 and 1000 characters in length.

Errors

Returns an error of type ScheduledEventDescription if the description is invalid.

pub fn entity_type(self, entity_type: EntityType) -> Self

Set the EntityType of the scheduled event.

See the struct-level documentation for information about required fields for each type.

pub const fn image(self, image: Option<&'a str>) -> Self

Set the cover image of the event.

Pass None to clear the image.

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. See Discord Docs/Image Data.

pub const fn location(self, location: Option<&'a str>) -> Self

Set the location of the external scheduled event.

This only functions if the event’s EntityType is External.

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

Set the name of the event.

Must be between 1 and 100 characters in length.

Errors

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

pub const fn scheduled_end_time( self, scheduled_end_time: Option<&'a Timestamp> ) -> Self

Set the scheduled end time of the event.

Required for external events.

pub const fn scheduled_start_time( self, scheduled_start_time: &'a Timestamp ) -> Self

Set the scheduled start time of the event.

pub const fn status(self, status: Status) -> Self

Set the status of the event.

If an event is currently Scheduled, it can only be set to Active or Cancelled. If it is currently Active, it can only be set to Completed. Otherwise, the status can not be updated.

pub fn exec(self) -> ResponseFuture<GuildScheduledEvent>

👎Deprecated since 0.14.0: use .await or into_future instead

Execute the request, returning a future resolving to a Response.

Trait Implementations

impl<'a> AuditLogReason<'a> for UpdateGuildScheduledEvent<'a>

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

Attach an audit log reason to the request.

impl IntoFuture for UpdateGuildScheduledEvent<'_>

type Output = Result<Response<GuildScheduledEvent>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<GuildScheduledEvent>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for UpdateGuildScheduledEvent<'_>

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

Try to convert a request builder into a raw Request.