yde/io.github.ydwk.yde.impl.entities/GuildImpl

GuildImpl

class GuildImpl(val yde: YDE, val json: JsonNode, val idAsLong: Long) : Guild(source)

Constructors

constructor(yde: YDE, json: JsonNode, idAsLong: Long)

Functions

open fun banMember(member: Member, deleteMessageDuration: Duration = Duration.ZERO, reason: String? = null): CompletableDeferred<NoResult>

Bans a member from the guild.

banUser

open fun banUser(userId: Long, reason: String? = null): CompletableDeferred<NoResult>

open fun banUser(userId: String, reason: String? = null): CompletableDeferred<NoResult>

open fun banUser(user: User, deleteMessageDuration: Duration = Duration.ZERO, reason: String? = null): CompletableDeferred<NoResult>

open fun banUser(userId: Long, deleteMessageDuration: Duration = Duration.ZERO, reason: String? = null): CompletableDeferred<NoResult>

open fun banUser(userId: String, deleteMessageDuration: Duration = Duration.ZERO, reason: String? = null): CompletableDeferred<NoResult>

Bans a user from the guild.

createDmChannel

open fun createDmChannel(user: User): CompletableDeferred<DmChannel>

open fun createDmChannel(userId: String): CompletableDeferred<DmChannel>

Creates a dm channel.

open fun createDmChannel(userId: Long): CompletableDeferred<DmChannel>

Creates a dm channel..

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}.

getChannelById

open fun getChannelById(channelId: String): GuildChannel?

open override fun getChannelById(channelId: Long): GuildChannel?

The channel by its id.

getChannelGetterById

open fun getChannelGetterById(channelId: Long): GuildChannelGetter?

open fun getChannelGetterById(channelId: String): GuildChannelGetter?

The channel getter by its id.

getMemberById

open fun getMemberById(userId: Long): Member?

open fun getMemberById(userId: String): Member?

The member by its user id.

getRoleById

open fun getRoleById(roleId: String): Role?

open override fun getRoleById(roleId: Long): Role?

Gets a role from the guild.

kickMember

open fun kickMember(member: Member, reason: String? = null): CompletableDeferred<NoResult>

open fun kickMember(userId: Long, reason: String? = null): CompletableDeferred<NoResult>

open fun kickMember(userId: String, reason: String? = null): CompletableDeferred<NoResult>

Kicks a member from the guild.

requestedAuditLog

open fun requestedAuditLog(): CompletableDeferred<AuditLog>

open fun requestedAuditLog(user: User): CompletableDeferred<AuditLog>

open fun requestedAuditLog(userId: GetterSnowFlake): CompletableDeferred<AuditLog>

open fun requestedAuditLog(user: User, limit: Int): CompletableDeferred<AuditLog>

open fun requestedAuditLog(userId: GetterSnowFlake, limit: Int): CompletableDeferred<AuditLog>

open fun requestedAuditLog(user: User, limit: Int, before: GetterSnowFlake): CompletableDeferred<AuditLog>

open fun requestedAuditLog(userId: GetterSnowFlake, limit: Int, before: GetterSnowFlake): CompletableDeferred<AuditLog>

open fun requestedAuditLog(user: User? = null, limit: Int = 50, before: GetterSnowFlake? = null, actionType: AuditLogType? = null): CompletableDeferred<AuditLog>

open fun requestedAuditLog(userId: GetterSnowFlake? = null, limit: Int = 50, before: GetterSnowFlake? = null, actionType: AuditLogType? = null): CompletableDeferred<AuditLog>

Request the audit log for the guild.

retrieveMembers

open fun retrieveMembers(limit: Int): CompletableDeferred<List<Member>>

Gets all the members of the guild.

toString

open override fun toString(): String

Converts this entity to a string using the io.github.ydwk.ydwk.util.EntityToStringBuilder.

unbanUser

open fun unbanUser(user: User, reason: String? = null): CompletableDeferred<NoResult>

open fun unbanUser(userId: Long, reason: String? = null): CompletableDeferred<NoResult>

open fun unbanUser(userId: String, reason: String? = null): CompletableDeferred<NoResult>

Unbans a user from the guild.

Properties

afkChannelId

open override var afkChannelId: GetterSnowFlake?

The guild's afk channel id.

afkTimeout

open override var afkTimeout: Int

The guild's afk timeout.

applicationId

open override var applicationId: GetterSnowFlake?

The guild's application id.

approximateMemberCount

open override var approximateMemberCount: Int?

The approximate member count for the guild.

approximatePresenceCount

open override var approximatePresenceCount: Int?

The approximate presence count for the guild.

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.

banner

open override var banner: String?

The banner hash for the guild.

botAsMember

open override val botAsMember: Member

The bot as a member of the guild.

defaultMessageNotificationsLevel

open override var defaultMessageNotificationsLevel: MessageNotificationLevel

The guild's default message notification level.

description

open override var description: String?

The description for the guild.

discoverySplash

open override var discoverySplash: String?

The guild's discovery splash hash.

emojis

open override var emojis: List<Emoji>

The guild's emojis.

everyoneRole

open val everyoneRole: Role

The @everyone role. This role is always present.

explicitContentFilterLevel

open override var explicitContentFilterLevel: ExplicitContentFilterLevel

The guild's explicit content filter level.

features

open override var features: Set<GuildFeature>

The guild's features.

getCategories

open val getCategories: List<GuildCategory>

Gets all the categories as sorted list.

getChannels

open val getChannels: List<GuildChannel>

Gets all the channels as sorted list.

getTextChannels

open val getTextChannels: List<GuildTextChannel>

Gets all the text channels as sorted list.

getUnorderedChannels

open override val getUnorderedChannels: List<GuildChannel>

Gets all the channels as unordered list.

getVoiceChannels

open val getVoiceChannels: List<GuildVoiceChannel>

Gets all the voice channels as sorted list.

icon

open override var icon: String?

The guild's icon hash.

open val id: String

The id of this snowflake as a String.

idAsLong

open override val idAsLong: Long

The id of this snowflake as a Long.

isBoostProgressBarEnabled

open override var isBoostProgressBarEnabled: Boolean

Gets weather the guild has the boost progress bar enabled.

isOwner

open override var isOwner: Boolean?

Checks if this is user is owner of the guild.

isWidgetEnabled

open override var isWidgetEnabled: Boolean?

Checks if the guild's widget is enabled.

json

open override val json: JsonNode

The json representation of this entity.

maxMembers

open override var maxMembers: Int

The maximum number of members for the guild.

maxPresences

open override var maxPresences: Int?

The maximum number of presences for the guild (null is always returned, apart from the largest of guilds).

maxVideoChannelUsers

open override var maxVideoChannelUsers: Int?

The maximum amount of users in a video channel.

mfaLevel

open override var mfaLevel: MFALevel

The guild's mfa level.

name

open override var name: String

nsfwLevel

open override var nsfwLevel: NSFWLeveL

The guild's nsfw level.

ownerId

open override var ownerId: GetterSnowFlake

The guild's owner id.

permissions

open override var permissions: String?

The guild's permissions.

preferredLocale

open override var preferredLocale: String

The preferred locale for the guild.

premiumSubscriptionCount

open override var premiumSubscriptionCount: Int

The premium subscription count for the guild.

premiumTier

open override var premiumTier: PremiumTier

The premium tier for the guild.

publicUpdatesChannelId

open override var publicUpdatesChannelId: GetterSnowFlake?

The public updates channel id for the guild.

requestBans

open val requestBans: CompletableDeferred<List<Ban>>

Requests a list of ban's for the guild.

retrieveMembers

open val retrieveMembers: CompletableDeferred<List<Member>>

Gets all the members of the guild.

roles

open override var roles: List<Role>

The guild's roles.

rulesChannelId

open override var rulesChannelId: GetterSnowFlake?

The guild's rules channel id.

splash

open override var splash: String?

The guild's splash hash.

stickers

open override var stickers: List<Sticker>

The guild's custom stickers.

systemChannelFlags

open override var systemChannelFlags: SystemChannelFlag

The guild's system channel flags.

systemChannelId

open override var systemChannelId: GetterSnowFlake?

The guild's system channel id.

vanityUrlCode

open override var vanityUrlCode: String?

The vanity url code for the guild.

verificationLevel

open override var verificationLevel: VerificationLevel

The guild's verification level.

voiceStates

open override val voiceStates: List<VoiceState>

All the current voice states for the guild.

welcomeScreen

open override var welcomeScreen: WelcomeScreen?

The welcome screen of the guild.

widgetChannelId

open override var widgetChannelId: GetterSnowFlake?

The guild's widget channel id.

yde

open override val yde: YDE

The main YDE instance.