kord-core/dev.kord.core.entity/StageInstance

StageInstance

class StageInstance(val data: StageInstanceData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : StageInstanceBehavior(source)

Constructors

StageInstance

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

Properties

channelId

open override val channelId: Snowflake

The id of the associated StageChannel.

data

val data: StageInstanceData

guildId

val guildId: Snowflake

The guild id of the associated StageChannel.

guildScheduledEventId

val guildScheduledEventId: Snowflake?

The id of the GuildScheduledEvent for this Stage Instance, if it belongs to an event.

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

privacyLevel

val privacyLevel: StageInstancePrivacyLevel

The privacy level of this Stage Instance.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

topic

val topic: String

The topic of this Stage Instance.

Functions

asStageInstance

open suspend override fun asStageInstance(): StageInstance

Requests to get this behavior as a StageInstance if it's not an instance of a StageInstance.

asStageInstanceOrNull

open suspend override fun asStageInstanceOrNull(): StageInstance

Requests to get this behavior as a StageInstance if it's not an instance of a StageInstance, returns null if the stage instance isn't present.

compareTo

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

Compares entities on id.

delete

open suspend fun delete(reason: String? = null)

edit

inline suspend fun StageInstanceBehavior.edit(builder: StageInstanceModifyBuilder.() -> Unit): StageInstance

fetchStageInstance

open suspend fun fetchStageInstance(): StageInstance

Retrieve the StageInstance associated with this behaviour from the provided EntitySupplier

fetchStageInstanceOrNull

open suspend fun fetchStageInstanceOrNull(): StageInstance?

Retrieve the StageInstance associated with this behaviour from the provided EntitySupplier returns null if the StageInstance isn't present.

withStrategy

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

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