kord-core/dev.kord.core.entity/Member

Member

class Member(val memberData: MemberData, userData: UserData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : User, MemberBehavior(source)

An instance of a Discord Member.

Constructors

Member

constructor(memberData: MemberData, userData: UserData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

accentColor

val accentColor: Color?

avatar

val avatar: Asset?

The avatar of this user as an Asset.

avatarDecoration

val avatarDecoration: Asset?

avatarDecorationHash

val avatarDecorationHash: String?

avatarHash

val avatarHash: String?

banner

val banner: Asset?

bannerHash

val bannerHash: String?

communicationDisabledUntil

val communicationDisabledUntil: Instant?

The Instant until the user's timeout expires, or null if the user does not have a timeout.

data

val data: UserData

defaultAvatar

val defaultAvatar: Asset

discriminator

val discriminator: String

The 4-digit code at the end of the user's discord tag.

effectiveName

val effectiveName: String

The member's effective name, prioritizing nickname over globalName and username.

effectiveName

val User.effectiveName: String

The user's effective name, prioritizing globalName over username.

flags

val flags: GuildMemberFlags

The GuildMemberFlags of this member.

globalName

val globalName: String?

The user's display name, if it is set. For bots, this is the application name.

guild

open val guild: GuildBehavior

The guild this channel is associated to.

guildId

open override val guildId: Snowflake

The id of the guild this channel is associated to.

open override val id: Snowflake

The unique identifier of this entity.

isBot

val isBot: Boolean

Whether this user is a bot account.

isPending

val isPending: Boolean

Whether the user has not yet passed the guild's Membership Screening requirements.

isSelf

val isSelf: Boolean

Returns true if the user is the same as the bot.

joinedAt

val joinedAt: Instant?

When the user joined this guild.

kord

open override val kord: Kord

The kord instance that created this object.

memberAvatar

val memberAvatar: Asset?

The guild avatar of this member as an Asset.

memberAvatarHash

val memberAvatarHash: String?

memberData

val memberData: MemberData

mention

open val mention: String

nickname

val nickname: String?

The guild-specific nickname of the user, if present.

permissions

val permissions: Permissions?

The total Permissions of this member in the channel an interaction was sent from.

premiumSince

val premiumSince: Instant?

When the user used their Nitro boost on the server.

publicFlags

val publicFlags: UserFlags?

The flags on a user's account, if present.

roleBehaviors

val roleBehaviors: Set<RoleBehavior>

The behaviors of the roles that apply to this user.

roleIds

val roleIds: Set<Snowflake>

The ids of the roles that apply to this user.

roles

val roles: Flow<Role>

The roles that apply to this user.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

tag

val tag: String

The complete user tag.

username

val username: String

The username of this user.

Functions

addRole

open suspend fun addRole(roleId: Snowflake, reason: String? = null)

Requests to add the Role with the roleId to this member.

asMember

open suspend override fun asMember(): Member

Requests to get the this behavior as a Member.

open suspend override fun asMember(guildId: Snowflake): Member

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

asMemberOrNull

open suspend override fun asMemberOrNull(): Member

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

open suspend override 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 override fun asUser(): User

Requests to get the this behavior as a User.

asUserOrNull

open suspend override fun asUserOrNull(): User

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

ban

inline suspend fun MemberBehavior.ban(builder: BanCreateBuilder.() -> Unit = {})

Requests to ban this member.

compareTo

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

Compares entities on id.

edit

inline suspend fun MemberBehavior.edit(builder: MemberModifyBuilder.() -> Unit): Member

Requests to edit this member.

equals

open operator override fun equals(other: Any?): Boolean

fetchMember

open suspend fun fetchMember(): Member

open suspend fun fetchMember(guildId: Snowflake): Member

Retrieve the Member associated with this behaviour from the provided EntitySupplier

fetchMemberOrNull

open suspend fun fetchMemberOrNull(): Member?

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.

getGuild

open suspend fun getGuild(): Guild

Requests to get the Guild this member is part of.

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

Requests to get the Guild this member is part of, returns null if the Guild isn't present.

getPermissions

suspend fun getPermissions(): Permissions

Requests to calculate a summation of the permissions of this member's roles.

getPresence

open suspend fun getPresence(): Presence

Requests to get the Presence of this member in the guild.

getPresenceOrNull

open suspend fun getPresenceOrNull(): Presence?

Requests to get the Presence of this member in the guild, returns null if the Presence isn't present.

getVoiceState

open suspend fun getVoiceState(): VoiceState

Requests to get the VoiceState of this member in the guild.

getVoiceStateOrNull

open suspend fun getVoiceStateOrNull(): VoiceState?

Requests to get the VoiceState of this member in the guild, returns null if the VoiceState isn't present.

hashCode

open override fun hashCode(): Int

isOwner

suspend fun isOwner(): Boolean

Whether this member's id equals the Guild.ownerId.

kick

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

Requests to kick this member from its guild.

live

@KordPreview

fun Member.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveMember

@KordPreview

fun User.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveUser

@KordPreview

inline fun Member.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job), block: LiveMember.() -> Unit): LiveMember

@KordPreview

inline fun User.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job), block: LiveUser.() -> Unit): LiveUser

removeRole

open suspend fun removeRole(roleId: Snowflake, reason: String? = null)

Requests to remove the Role with the roleId from this member.

toString

open override fun toString(): String

withStrategy

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

Returns a new Member with the given strategy.