Packages

c

ackcord.data

GuildScheduledEvent

case class GuildScheduledEvent(id: SnowflakeType[GuildScheduledEvent], guildId: GuildId, channelId: Option[VoiceGuildChannelId], creatorId: Option[UserId], name: String, description: Option[String], scheduledStartTime: OffsetDateTime, scheduledEndTime: Option[OffsetDateTime], privacyLevel: GuildScheduledEventPrivacyLevel, status: GuildScheduledEventStatus, entityType: GuildScheduledEventEntityType, entityId: Option[SnowflakeType[StageInstance]], entityMetadata: Option[GuildScheduledEventEntityMetadata], creator: Option[User], userCount: Option[Int]) extends Product with Serializable

A scheduled event within a guild.

id

The id of the event

guildId

The id of the guild the event takes place in.

channelId

The id of the channel the event takes place in, if it takes place in a channel.

creatorId

The creator id of the event.

name

Name of the event.

description

Description of the event.

scheduledStartTime

Time the event will start.

scheduledEndTime

Time the event will end.

privacyLevel

Privacy level of the event.

status

Status of the event.

entityType

The type of the event.

entityId

Id of an entity associated with the event.

entityMetadata

Additional metadata.

creator

The creator of the event.

userCount

Number of users subscribed to the event.

Source
guildScheduledEvent.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GuildScheduledEvent
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GuildScheduledEvent(id: SnowflakeType[GuildScheduledEvent], guildId: GuildId, channelId: Option[VoiceGuildChannelId], creatorId: Option[UserId], name: String, description: Option[String], scheduledStartTime: OffsetDateTime, scheduledEndTime: Option[OffsetDateTime], privacyLevel: GuildScheduledEventPrivacyLevel, status: GuildScheduledEventStatus, entityType: GuildScheduledEventEntityType, entityId: Option[SnowflakeType[StageInstance]], entityMetadata: Option[GuildScheduledEventEntityMetadata], creator: Option[User], userCount: Option[Int])

    id

    The id of the event

    guildId

    The id of the guild the event takes place in.

    channelId

    The id of the channel the event takes place in, if it takes place in a channel.

    creatorId

    The creator id of the event.

    name

    Name of the event.

    description

    Description of the event.

    scheduledStartTime

    Time the event will start.

    scheduledEndTime

    Time the event will end.

    privacyLevel

    Privacy level of the event.

    status

    Status of the event.

    entityType

    The type of the event.

    entityId

    Id of an entity associated with the event.

    entityMetadata

    Additional metadata.

    creator

    The creator of the event.

    userCount

    Number of users subscribed to the event.

Value Members

  1. val channelId: Option[VoiceGuildChannelId]
  2. val creator: Option[User]
  3. val creatorId: Option[UserId]
  4. val description: Option[String]
  5. val entityId: Option[SnowflakeType[StageInstance]]
  6. val entityMetadata: Option[GuildScheduledEventEntityMetadata]
  7. val entityType: GuildScheduledEventEntityType
  8. val guildId: GuildId
  9. val id: SnowflakeType[GuildScheduledEvent]
  10. val name: String
  11. val privacyLevel: GuildScheduledEventPrivacyLevel
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. val scheduledEndTime: Option[OffsetDateTime]
  14. val scheduledStartTime: OffsetDateTime
  15. val status: GuildScheduledEventStatus
  16. val userCount: Option[Int]