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

Member

interface Member : NameAbleEntity, GenericEntity, SendAble, SnowFlake, PermissionEntity(source)

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

Inheritors

Functions

Link copied to clipboard
open fun addRole(role: Role): CompletableDeferred<NoResult>

Adds a role to this member.

Link copied to clipboard
open fun addRoles(vararg roles: Role): List<CompletableDeferred<NoResult>>
open fun addRoles(roles: List<Role>): List<CompletableDeferred<NoResult>>

Adds a list of roles to this member.

Link copied to clipboard
open fun format(format: String): String

Formats the name of the entity

Link copied to clipboard
open override fun formatTo(formatter: Formatter?, flags: Int, width: Int, precision: Int)

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

Link copied to clipboard
abstract fun hasPermission(vararg permission: GuildPermission): Boolean
abstract fun hasPermission(permission: Collection<GuildPermission>): Boolean

Checks if the member has a specific permission.

Link copied to clipboard
open fun removeRole(role: Role): CompletableDeferred<NoResult>

Removes a role from this member.

Link copied to clipboard
open fun removeRoles(vararg roles: Role): List<CompletableDeferred<NoResult>>
open fun removeRoles(roles: List<Role>): List<CompletableDeferred<NoResult>>

Removes a list of roles from this member.

Link copied to clipboard
open suspend fun send(): CompletableDeferred<Message>

Sends the message.

Link copied to clipboard
open fun setContent(message: String): SendAble

Sets the content of the message.

Link copied to clipboard
open fun setEmbed(embed: Embed): SendAble

Sets the embed of the message.

Link copied to clipboard
open fun setEmbeds(vararg embeds: Embed): SendAble
open fun setEmbeds(embeds: List<Embed>): SendAble

Sets the embeds of the message.

Link copied to clipboard
open fun setFlag(flag: MessageFlag): SendAble

Set a message flag.

Link copied to clipboard
open fun setFlags(vararg flags: MessageFlag): SendAble
open fun setFlags(flags: List<MessageFlag>): SendAble

Sets the message flags.

Link copied to clipboard
open fun setTts(tts: Boolean): SendAble

Whether the message should be sent with text-to-speech.

Properties

Link copied to clipboard
open val asIncrement: Long

The increment of this snowflake.

Link copied to clipboard
open val asProcessId: Long

The process id of this snowflake.

Link copied to clipboard
open val asTimestamp: Long

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

Link copied to clipboard
open val asWorkerId: Long

The worker id of this snowflake.

Link copied to clipboard
open val createDmChannel: CompletableDeferred<DmChannel>

Creates a direct message channel with this member.

Link copied to clipboard
abstract var deaf: Boolean

Whether the member is deafened in voice channels.

Link copied to clipboard
abstract val guild: Guild

Gets thw member's Guild.

Link copied to clipboard
abstract val guildAvatar: Avatar?

The member's guild avatar.

Link copied to clipboard
abstract var guildAvatarHash: String?

The member's guild avatar hash.

Link copied to clipboard
open val id: String

The id of this snowflake as a String.

Link copied to clipboard
abstract val idAsLong: Long

The id of this snowflake as a Long.

Link copied to clipboard
abstract val isOwner: Boolean

Whether the member is the owner of the guild.

Link copied to clipboard
open val isTimedOut: Boolean

Weather this member is timed out.

Link copied to clipboard
abstract var joinedAt: String?

The time this member joined the guild.

Link copied to clipboard
abstract val json: JsonNode

The json representation of this entity.

Link copied to clipboard
open val messageBuilder: MessageBuilder

The actual message builder instance.

Link copied to clipboard
abstract var mute: Boolean

Whether the member is muted in voice channels.

Link copied to clipboard
abstract var name: String
Link copied to clipboard
abstract var nick: String?

Gets this member guild nickname.

Link copied to clipboard
abstract var pending: Boolean

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

Link copied to clipboard
abstract val permissions: EnumSet<GuildPermission>

The permissions of this member.

Link copied to clipboard
abstract var premiumSince: String?

The date the member started boosting the guild.

Link copied to clipboard
abstract val roleIds: List<GetterSnowFlake>

The ids of the roles this member is assigned.

Link copied to clipboard
abstract val roles: List<Role?>

The roles of this member.

Link copied to clipboard
abstract var timedOutUntil: String?

If the member is timed out, then this is the time at which the timeout will end.

Link copied to clipboard
abstract var user: User

The user this guild member represents.

Link copied to clipboard
abstract var voiceState: VoiceState?

If the member is in avc it will get there voice state.

Link copied to clipboard
abstract val yde: YDE

The main YDE instance.