kord-core/dev.kord.core.behavior/RoleBehavior

RoleBehavior

interface RoleBehavior : KordEntity, Strategizable(source)

The behavior of a Discord Role associated to a guild.

Inheritors

Role

Properties

guild

open val guild: GuildBehavior

The guild behavior this channel is associated to.

guildId

abstract val guildId: Snowflake

The id of the guild this channel is associated to.

abstract val id: Snowflake

The unique identifier of this entity.

kord

abstract val kord: Kord

The kord instance that created this object.

mention

open val mention: String

The raw mention of this entity.

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

Functions

asRole

open suspend fun asRole(): Role

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

asRoleOrNull

open suspend fun asRoleOrNull(): Role?

Requests to get this behavior as a Role if its not an instance of a Role, returns null if the user isn't present.

changePosition

open suspend fun changePosition(position: Int): Flow<Role>

Requests to change the position of this role.

compareTo

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

Compares entities on id.

delete

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

Requests to delete this role.

edit

inline suspend fun RoleBehavior.edit(builder: RoleModifyBuilder.() -> Unit): Role

Requests to edit this role.

fetchRole

open suspend fun fetchRole(): Role

Retrieve the Role associated with this behaviour from the provided EntitySupplier

fetchRoleOrNull

open suspend fun fetchRoleOrNull(): Role?

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

getPosition

open suspend fun getPosition(): Int

Requests to get the position of this role in the role list of this guild.

withStrategy

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

Returns a new RoleBehavior with the given strategy.