yde/io.github.ydwk.yde.entities.guild/Role

Role

interface Role : SnowFlake, GenericEntity, NameAbleEntity, PermissionEntity(source)

This class is used to represent a discord guild role entity.

Inheritors

RoleImpl

Functions

format

open fun format(format: String): String

Formats the name of the entity

formatTo

open override fun formatTo(formatter: Formatter?, flags: Int, width: Int, precision: Int)

Formats the object using the provided {@link Formatter formatter}.

hasPermission

abstract fun hasPermission(vararg permission: GuildPermission): Boolean

abstract fun hasPermission(permission: Collection<GuildPermission>): Boolean

Checks if the member has a specific permission.

Properties

asIncrement

open val asIncrement: Long

The increment of this snowflake.

asProcessId

open val asProcessId: Long

The process id of this snowflake.

asTimestamp

open val asTimestamp: Long

The timestamp of this snowflake. (Milliseconds since Discord Epoch, the first second of 2015 or 1420070400000.)

asWorkerId

open val asWorkerId: Long

The worker id of this snowflake.

color

abstract var color: Color

The color of this role.

icon

abstract var icon: String?

The icon hash of this role.

open val id: String

The id of this snowflake as a String.

idAsLong

abstract val idAsLong: Long

The id of this snowflake as a Long.

isHoisted

abstract var isHoisted: Boolean

Gets weather this role is hoisted (if this role is pinned in the user listing).

isManaged

abstract var isManaged: Boolean

The managed status of this role.

isMentionable

abstract var isMentionable: Boolean

Gets whether this role is mentionable.

json

abstract val json: JsonNode

The json representation of this entity.

name

abstract var name: String

permissions

abstract val permissions: EnumSet<GuildPermission>

The permissions of this member.

position

abstract var position: Int

The position of this role.

rawPermissions

abstract var rawPermissions: Long

The raw permissions of this role.