yde/io.github.ydwk.yde.rest.methods/GuildRestAPIMethods

GuildRestAPIMethods

interface GuildRestAPIMethods(source)

Inheritors

Functions

Link copied to clipboard
abstract fun banUser(guildId: Long, userId: Long, deleteMessageDuration: Duration = Duration.ZERO, reason: String? = null): CompletableDeferred<NoResult>

Bans a user from the guild.

Link copied to clipboard
abstract fun kickMember(guildId: Long, userId: Long, reason: String? = null): CompletableDeferred<NoResult>

Kicks a member from the guild.

Link copied to clipboard
abstract fun requestedAuditLog(guildId: Long, userId: GetterSnowFlake? = null, limit: Int = 50, before: GetterSnowFlake? = null, actionType: AuditLogType? = null): CompletableDeferred<AuditLog>

Request the audit log for the guild.

Link copied to clipboard
abstract fun requestedBanList(guildId: Long): CompletableDeferred<List<Ban>>

Requests the ban list for the guild.

Link copied to clipboard
abstract fun requestedGuild(guildId: Long): CompletableDeferred<Guild>

Request to get a guild by its id.

Link copied to clipboard
abstract fun requestedGuilds(): CompletableDeferred<List<Guild>>

Request to get all the guilds the bot is in.

Link copied to clipboard
open fun requestedMembers(guild: Guild): CompletableDeferred<List<Member>>

Request to get all the members within the guild.

abstract fun requestedMembers(guild: Guild, limit: Int?): CompletableDeferred<List<Member>>

Request to get the amount of members specified by the limit.

Link copied to clipboard
abstract fun unbanUser(guildId: Long, userId: Long, reason: String? = null): CompletableDeferred<NoResult>

Unbans a user from the guild.