yde/io.github.ydwk.yde.impl/YDEImpl

YDEImpl

open class YDEImpl(token: String? = null, var applicationId: String? = null, client: OkHttpClient, guildIdList: MutableList<String> = mutableListOf(), val githubRepositoryUrl: String, val wrapperVersion: String) : YDE(source)

Constructors

constructor(token: String? = null, applicationId: String? = null, client: OkHttpClient, guildIdList: MutableList<String> = mutableListOf(), githubRepositoryUrl: String, wrapperVersion: String)

Functions

createDmChannel

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

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

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

Creates a dm channel.

open fun getChannelById(id: String): Channel?

open override fun getChannelById(id: Long): Channel?

Gets a channel by its id.

open override fun getChannels(): List<Channel>

Gets all the channels the bot can see.

open fun getGuildById(id: Long): Guild?

open override fun getGuildById(id: String): Guild?

Gets a guild by its id.

getGuildChannelById

open fun getGuildChannelById(id: Long): GuildChannel?

open fun getGuildChannelById(id: String): GuildChannel?

Gets a guild channel by its id.

getGuildChannelGetterById

open fun getGuildChannelGetterById(id: Long): GuildChannelGetter?

open fun getGuildChannelGetterById(id: String): GuildChannelGetter?

Gets guild channels by their ids.

getGuildChannels

open fun getGuildChannels(): List<GuildChannel>

Gets all the guild channels the bot can see.

open override fun getGuilds(): List<Guild>

Gets all the guilds the bot is in.

open fun getMemberById(guildId: String, userId: String): Member?

open override fun getMemberById(guildId: Long, userId: Long): Member?

Gets a member by its id.

open override fun getMembers(): List<Member>

Gets all the members in all the guilds the bot is in.

open fun getUserById(id: String): User?

open override fun getUserById(id: Long): User?

Gets a user by its id.

open override fun getUsers(): List<User>

Gets all the users the bot can see.

requestChannelById

open fun requestChannelById(id: Long): CompletableDeferred<Channel>

open fun requestChannelById(id: String): CompletableDeferred<Channel>

Requests a channel using its id.

open fun requestGuild(guildId: Long): CompletableDeferred<Guild>

open fun requestGuild(guildId: String): CompletableDeferred<Guild>

Requests a guild using its id.

requestGuildChannelById

open fun requestGuildChannelById(id: Long, guildId: Long): CompletableDeferred<GuildChannel>

open fun requestGuildChannelById(id: String, guildId: String): CompletableDeferred<GuildChannel>

Requests a guild channel using its id.

requestGuildChannels

open fun requestGuildChannels(guildId: Long): CompletableDeferred<List<GuildChannel>>

open fun requestGuildChannels(guildId: String): CompletableDeferred<List<GuildChannel>>

Requests a list of guild channels by the guild id.

open fun requestGuilds(): CompletableDeferred<List<Guild>>

Requests all the guilds the bot is in.

open fun requestUser(id: Long): CompletableDeferred<User>

open fun requestUser(id: String): CompletableDeferred<User>

Requests a user using its id.

open fun requestUsers(): CompletableDeferred<List<User>>

Requests all the users the bot can see.

setAllowedCache

open fun setAllowedCache(cacheIds: MutableList<CacheIds>)

open override fun setAllowedCache(vararg cacheIds: CacheIds)

Sets the allowed cache ids.

setDisallowedCache

open fun setDisallowedCache(cacheIds: MutableList<CacheIds>)

open override fun setDisallowedCache(vararg cacheIds: CacheIds)

Sets the disallowed cache ids.

open fun setGuildIds(vararg guildIds: Long)

open fun setGuildIds(guildIds: MutableList<String>)

open override fun setGuildIds(vararg guildIds: String)

Sets the guild ids for guild commands

open override fun toString(): String

Overrides the custom to string method.

triggerCacheClear

open fun triggerCacheClear(duration: Long, repeat: Boolean = true)

open override fun triggerCacheClear(duration: Duration, repeat: Boolean)

Triggers a thread to clear the entire cache after a certain amount of time

triggerCacheTypeClear

open fun triggerCacheTypeClear(cacheId: CacheIds, duration: Long, repeat: Boolean = true)

open override fun triggerCacheTypeClear(cacheId: CacheIds, duration: Duration, repeat: Boolean)

Triggers a thread to clear a certain cache type after a certain amount of time

open fun triggerCacheTypeClear(cacheIds: List<CacheIds>, duration: Long, repeat: Boolean = true)

open override fun triggerCacheTypeClear(cacheIds: List<CacheIds>, duration: Duration, repeat: Boolean)

Triggers a thread to clear a list of cache types after a certain amount of time

Properties

open var applicationId: String?

open override val bot: Bot? = null

The properties of the bot.

val cache: Cache

open override val embedBuilder: EmbedBuilder

Used to build embeds.

open override val entityBuilder: EntityBuilder

The entity builder.

githubRepositoryUrl

open override val githubRepositoryUrl: String

The github repository url.

val logger: Logger

val memberCache: MemberCache

messageCommandBuilder

open override val messageCommandBuilder: IMessageCommandBuilder

Adds or removes message commands.

open override val objectMapper: ObjectMapper

Parses json, i.e. convert plain text json to Jackson classes such as JsonNode.

open override val objectNode: ObjectNode

Creates a json object

open override val restApiManager: RestApiManager

The rest api manager.

restAPIMethodGetters

open override val restAPIMethodGetters: RestAPIMethodGetters

The place where all the RestAPI Methods are stored.

open override val slashBuilder: ISlashCommandBuilder

Adds or removes slash commands.

open override val threadFactory: ThreadFactory

The thread factory used by the bot.

userCommandBuilder

open override val userCommandBuilder: IUserCommandBuilder

Adds or removes user commands.

open override val wrapperVersion: String

The wrapper version.