kord-common/dev.kord.common.entity/DiscordGuildScheduledEvent

DiscordGuildScheduledEvent

data class DiscordGuildScheduledEvent(val id: Snowflake, val guildId: Snowflake, val channelId: Snowflake?, val creatorId: OptionalSnowflake? = OptionalSnowflake.Missing, val name: String, val description: Optional<String?> = Optional.Missing(), val scheduledStartTime: Instant, val scheduledEndTime: Instant?, val privacyLevel: GuildScheduledEventPrivacyLevel, val status: GuildScheduledEventStatus, val entityType: ScheduledEntityType, val entityId: Snowflake?, val entityMetadata: GuildScheduledEventEntityMetadata?, val creator: Optional<DiscordUser> = Optional.Missing(), val userCount: OptionalInt = OptionalInt.Missing, val image: Optional<String?> = Optional.Missing())(source)

Representation of a Guild Scheduled Event Structure.

Constructors

DiscordGuildScheduledEvent

constructor(id: Snowflake, guildId: Snowflake, channelId: Snowflake?, creatorId: OptionalSnowflake? = OptionalSnowflake.Missing, name: String, description: Optional<String?> = Optional.Missing(), scheduledStartTime: Instant, scheduledEndTime: Instant?, privacyLevel: GuildScheduledEventPrivacyLevel, status: GuildScheduledEventStatus, entityType: ScheduledEntityType, entityId: Snowflake?, entityMetadata: GuildScheduledEventEntityMetadata?, creator: Optional<DiscordUser> = Optional.Missing(), userCount: OptionalInt = OptionalInt.Missing, image: Optional<String?> = Optional.Missing())

Properties

@SerialName(value = "channel_id")

val channelId: Snowflake?

The channel id in which the scheduled event will be hosted, or null if entityType is External.

val creator: Optional<DiscordUser>

The user that created the scheduled event.

@SerialName(value = "creator_id")

val creatorId: OptionalSnowflake?

The id of the user that created the scheduled event.

val description: Optional<String?>

The description of the scheduled event.

@SerialName(value = "entity_id")

val entityId: Snowflake?

The id of an entity associated with a guild scheduled event.

@SerialName(value = "entity_metadata")

val entityMetadata: GuildScheduledEventEntityMetadata?

Additional metadata for the guild scheduled event.

@SerialName(value = "entity_type")

val entityType: ScheduledEntityType

The type of the scheduled event.

@SerialName(value = "guild_id")

val guildId: Snowflake

The guild id which the scheduled event belongs to.

val id: Snowflake

The id of the scheduled event.

val image: Optional<String?>

The cover image hash of the scheduled event.

val name: String

The name of the scheduled event.

@SerialName(value = "privacy_level")

val privacyLevel: GuildScheduledEventPrivacyLevel

The privacy level of the scheduled event.

scheduledEndTime

@SerialName(value = "scheduled_end_time")

val scheduledEndTime: Instant?

The Instant in which the scheduled event will end, if any.

scheduledStartTime

@SerialName(value = "scheduled_start_time")

val scheduledStartTime: Instant

The Instant in which the scheduled event will start.

val status: GuildScheduledEventStatus

The status of the scheduled event.

@SerialName(value = "user_count")

val userCount: OptionalInt

The number of users subscribed to the scheduled event.