grom - v5.1.0

grom/guild/scheduled_event

Types

CoverImageFormat

</> 
pub type CoverImageFormat {
  PngCoverImage
  JpegCoverImage
  WebpCoverImage
}

Constructors 

  • PngCoverImage
  • JpegCoverImage
  • WebpCoverImage

Create

</> 
pub type Create {
  CreateExternal(
    entity_metadata: EntityMetadata,
    name: String,
    privacy_level: PrivacyLevel,
    scheduled_start_time: timestamp.Timestamp,
    scheduled_end_time: timestamp.Timestamp,
    description: option.Option(String),
    image: option.Option(image.Data),
    recurrence_rule: option.Option(recurrence_rule.Create),
  )
  CreateInStageInstance(
    channel_id: String,
    name: String,
    privacy_level: PrivacyLevel,
    scheduled_start_time: timestamp.Timestamp,
    scheduled_end_time: option.Option(timestamp.Timestamp),
    description: option.Option(String),
    image: option.Option(image.Data),
    recurrence_rule: option.Option(recurrence_rule.Create),
  )
  CreateInVoiceChannel(
    channel_id: String,
    name: String,
    privacy_level: PrivacyLevel,
    scheduled_start_time: timestamp.Timestamp,
    scheduled_end_time: option.Option(timestamp.Timestamp),
    description: option.Option(String),
    image: option.Option(image.Data),
    recurrence_rule: option.Option(recurrence_rule.Create),
  )
}

Constructors

EntityMetadata

</> 
pub type EntityMetadata {
  EntityMetadata(location: option.Option(String))
}

Constructors

EntityType

</> 
pub type EntityType {
  InStageInstance
  InVoiceChannel
  ExternallyHosted
}

Constructors 

  • InStageInstance
  • InVoiceChannel
  • ExternallyHosted

PrivacyLevel

</> 
pub type PrivacyLevel {
  GuildOnly
}

Constructors 

  • GuildOnly

ScheduledEvent

</> 
pub type ScheduledEvent {
  ScheduledEvent(
    id: String,
    guild_id: String,
    channel_id: option.Option(String),
    creator_id: option.Option(String),
    name: String,
    description: option.Option(String),
    scheduled_start_time: timestamp.Timestamp,
    scheduled_end_time: option.Option(timestamp.Timestamp),
    privacy_level: PrivacyLevel,
    status: Status,
    entity_type: EntityType,
    entity_id: option.Option(String),
    entity_metadata: option.Option(EntityMetadata),
    creator: option.Option(user.User),
    image_hash: option.Option(String),
    recurrence_rule: option.Option(recurrence_rule.RecurrenceRule),
  )
}

Constructors

Status

</> 
pub type Status {
  Scheduled
  Active
  Completed
  Canceled
}

Constructors 

  • Scheduled
  • Active
  • Completed
  • Canceled

Values

cover_image_request

</> 
pub fn cover_image_request(
  id id: String,
  hash cover_image: String,
  format format: CoverImageFormat,
) -> request.Request(String)

create

</> 
pub fn create(
  client: grom.Client,
  in guild_id: String,
  using create: Create,
  because reason: option.Option(String),
) -> Result(ScheduledEvent, grom.Error)

get

</> 
pub fn get(
  client: grom.Client,
  for guild_id: String,
  id event_id: String,
) -> Result(ScheduledEvent, grom.Error)
✨ Search Document