kord-core/dev.kord.core.entity/GuildScheduledEvent

GuildScheduledEvent

class GuildScheduledEvent(val data: GuildScheduledEventData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : GuildScheduledEventBehavior(source)

An instance of a Guild scheduled event belonging to a specific guild.

Constructors

GuildScheduledEvent

constructor(data: GuildScheduledEventData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

val channelId: Snowflake?

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

val creator: User?

The user that created this event.

val creatorId: Snowflake?

The id of the user that created this event.

val data: GuildScheduledEventData

val description: String?

The description of this event, if any.

val entityId: Snowflake?

The id of an entity associated with this event.

val entityMetadata: GuildScheduledEventEntityMetadata?

Additional metadata for this event.

val entityType: ScheduledEntityType

The type of this event.

open override val guildId: Snowflake

The id of the guild this event belongs to.

open override val id: Snowflake

The id of this event.

val image: Asset?

val imageHash: String?

The cover image hash of this event.

open override val kord: Kord

The kord instance that created this object.

open val members: Flow<Member>

val name: String

The name of this event.

val privacyLevel: GuildScheduledEventPrivacyLevel

The privacy level of this event.

scheduledEndTime

val scheduledEndTime: Instant?

The Instant in which this event will end, if any.

scheduledStartTime

val scheduledStartTime: Instant

The Instant in which this event will start.

val status: GuildScheduledEventStatus

The status of this event.

open override val supplier: EntitySupplier

The supplier used to request entities.

val userCount: Int?

The number of users subscribed to this event.

open val users: Flow<User>

Requests all the users which are interested in this event.

Functions

asGuildScheduledEvent

open suspend override fun asGuildScheduledEvent(): GuildScheduledEvent

Requests to get this behavior as a GuildScheduledEvent.

asGuildScheduledEventOrNull

open suspend override fun asGuildScheduledEventOrNull(): GuildScheduledEvent

Requests to get this behavior as a Guild, returns null if the event isn't present.

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

open suspend fun delete()

Deletes this event.

inline suspend fun GuildScheduledEventBehavior.edit(builder: ScheduledEventModifyBuilder.() -> Unit): GuildScheduledEvent

Requests to modify this event according to the specified builder.

fetchGuildScheduledEvent

open suspend fun fetchGuildScheduledEvent(): GuildScheduledEvent

Fetches this behavior as a GuildScheduledEvent.

fetchGuildScheduledEventOrNull

open suspend fun fetchGuildScheduledEventOrNull(): GuildScheduledEvent?

Fetches this behavior as a GuildScheduledEvent, returns null if the event isn't present.

getChannelOfOrNull

inline suspend fun <T : TopGuildChannel> getChannelOfOrNull(): T?

Requests the channel this event will be hosted in, if it is of type T, returns null if entityType is External, the channel is not present or not of type T.

getChannelOrNull

suspend fun getChannelOrNull(): TopGuildChannel?

Requests the TopGuildChannel this event will be hosted in, returns null if the TopGuildChannel isn't present or entityType is External.

suspend fun getGuild(): Guild

Requests the Guild this event belongs to.

suspend fun getGuildOrNull(): Guild?

Requests the Guild this event belongs to, returns null if the Guild isn't present.

getMembersAfter

open fun getMembersAfter(after: Snowflake, limit: Int? = null): Flow<Member>

getMembersBefore

open fun getMembersBefore(before: Snowflake, limit: Int? = null): Flow<Member>

open fun getUsersAfter(after: Snowflake, limit: Int? = null): Flow<User>

open fun getUsersBefore(before: Snowflake, limit: Int? = null): Flow<User>

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): Strategizable

Returns a copy of this class with a new supplier provided by the strategy.