Role

data class Role(val data: RoleData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : RoleBehavior(source)

Constructors

Role

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

Properties

color

val color: Color

data

val data: RoleData

flags

val flags: RoleFlags

The RoleFlags of this role.

guild

open val guild: GuildBehavior

The guild behavior this channel is associated to.

guildId

open override val guildId: Snowflake

The id of the guild this channel is associated to.

hoisted

val hoisted: Boolean

icon

val icon: Asset?

iconHash

val iconHash: String?

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

managed

val managed: Boolean

mention

open val mention: String

The raw mention of this entity.

mentionable

val mentionable: Boolean

name

val name: String

permissions

val permissions: Permissions

rawPosition

val rawPosition: Int

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

Functions

asRole

open suspend override fun asRole(): Role

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

asRoleOrNull

open suspend override 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.

equals

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

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.

hashCode

open override fun hashCode(): Int

live

@KordPreview

fun Role.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveRole

@KordPreview

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

toString

open override fun toString(): String

withStrategy

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

Returns a new Role with the given strategy.