kord-core/dev.kord.core.entity.channel.thread/ThreadMember

ThreadMember

class ThreadMember(val data: ThreadMemberData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ThreadMemberBehavior(source)

Constructors

ThreadMember

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

Properties

data

val data: ThreadMemberData

flags

val flags: Int

open override val id: Snowflake

The unique identifier of this entity.

joinTimestamp

val joinTimestamp: Instant

kord

open override val kord: Kord

The kord instance that created this object.

mention

open val mention: String

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

threadId

open override val threadId: Snowflake

Functions

asMember

open suspend fun asMember(guildId: Snowflake): Member

Requests to get the this behavior as a Member in the Guild with the guildId.

asMemberOrNull

open suspend fun asMemberOrNull(guildId: Snowflake): Member?

Requests to get this behavior as a Member in the Guild with the guildId, returns null if the member isn't present.

asUser

open suspend fun asUser(): User

Requests to get the this behavior as a User.

asUserOrNull

open suspend fun asUserOrNull(): User?

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

compareTo

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

Compares entities on id.

fetchMember

open suspend fun fetchMember(guildId: Snowflake): Member

Retrieve the Member associated with this behaviour from the provided EntitySupplier

fetchMemberOrNull

open suspend fun fetchMemberOrNull(guildId: Snowflake): Member?

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

fetchUser

open suspend fun fetchUser(): User

Retrieve the User associated with this behaviour from the provided EntitySupplier

fetchUserOrNull

open suspend fun fetchUserOrNull(): User?

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

getDmChannel

open suspend fun getDmChannel(): DmChannel

Requests to get or create a DmChannel between this bot and the user.

getDmChannelOrNull

open suspend fun getDmChannelOrNull(): DmChannel?

Requests to get or create a DmChannel between this bot and the user, returns null if the user does not allow DMs.

getThread

open suspend fun getThread(): ThreadChannel

getThreadOrNull

open suspend fun getThreadOrNull(): ThreadChannel?

withStrategy

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

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