diskord-core/com.jessecorbett.diskord.api.guild/GuildClient

GuildClient

class GuildClient(val guildId: String, client: RestClient) : RestClient(source)

A REST client for a specific guild and its content

Parameters

guildId

The id of the guild

client

The REST client implementation

Constructors

constructor(guildId: String, client: RestClient)

Properties

val guildId: String

Functions

suspend fun addMember(userId: String, addGuildMember: AddGuildMember)

Add a member to this guild.

suspend fun addMemberRole(userId: String, roleId: String)

Add a role to a user.

changeMemberNickname

suspend fun changeMemberNickname(guildMember: PatchGuildMemberNickname)

Change a guild member's nickname.

suspend fun GuildClient.changeNickname(nickname: String)

Changes the user's nickname in this client's guild.

suspend fun GuildClient.changeNickname(userId: String, nickname: String)

Changes a user's nickname in this client's guild.

suspend fun createBan(userId: String, createGuildBan: CreateGuildBan)

suspend fun createBan(userId: String, deleteMessageDays: Int, reason: String)

Ban a user.

suspend fun createChannel(channel: CreateChannel): Channel

Create a channel.

suspend fun createEmoji(createEmoji: CreateEmoji): Emoji

Create a custom emoji.

createIntegration

suspend fun createIntegration(guildIntegration: CreateGuildIntegration)

Create a guild integration.

suspend fun createRole(guildRole: CreateGuildRole): Role

Create a role.

suspend fun createSticker(sticker: CreateSticker): Sticker

Create a new sticker.

suspend fun createTemplate(createTemplate: CreateTemplate): Template

Create a template based on the current state of the guild

open suspend override fun DELETE(majorPath: String, minorPath: String, rateKey: String, block: HttpRequestBuilder.() -> Unit): HttpResponse

suspend fun deleteEmoji(emojiId: String)

Delete an emoji.

suspend fun deleteGuild()

Delete this guild. Use with caution, cannot be undone.

deleteIntegration

suspend fun deleteIntegration(guildIntegrationId: String)

Delete a guild integration.

suspend fun deleteRole(roleId: String)

Delete a role.

suspend fun deleteSticker(stickerId: String)

Delete a sticker

suspend fun deleteTemplate(templateCode: String)

Deletes a template

disconnectMemberVoiceChannel

suspend fun disconnectMemberVoiceChannel(userId: String)

Disconnects a guild member from the voice channel they are currently connected to.

open suspend override fun GET(majorPath: String, minorPath: String, rateKey: String, block: HttpRequestBuilder.() -> Unit): HttpResponse

suspend fun getAuditLog(userId: String? = null, actionType: AuditLogActionType? = null, before: String? = null, limit: Int = 50): AuditLog

Get the audit log.

suspend fun getBan(userId: String): Ban

Get a user's ban.

suspend fun getBans(): List<Ban>

Get user bans.

suspend fun getChannels(): List<Channel>

Get this guild's channels.

suspend fun getEmoji(): List<Emoji>

Get this guild's emoji.

suspend fun getEmoji(emojiId: String): Emoji

Get a custom emoji.

suspend fun getGuild(withCounts: Boolean = false): Guild

Get this guild.

getIntegrations

suspend fun getIntegrations(): List<GuildIntegration>

Get the list of integrations for the guild.

suspend fun getInvites(): List<Invite>

Get the guild invites.

suspend fun getMember(userId: String): GuildMember

Get a member of this guild.

suspend fun getMembers(limit: Int = 1, afterMember: String = "0"): List<GuildMember>

Get a list of guild members.

suspend fun getPreview(): GuildPreview

Get this guild preview.

getPrunePotential

suspend fun getPrunePotential(days: Int = 1, roles: List<String>? = null): Pruned

Get the message prune potential.

suspend fun getRoles(): List<Role>

Get all roles for this guild.

suspend fun getSticker(stickerId: String): Sticker

Get a specific sticker from this guild by sticker ID.

suspend fun getStickers(): List<Sticker>

Get a list of all sticker packs for this guild.

suspend fun getTemplates(): List<Template>

Get the templates for this guild

suspend fun getVanityUrl(): Invite

Get the guild's vanity url.

getVoiceRegions

suspend fun getVoiceRegions(): List<VoiceRegion>

Get the guild's voice regions.

suspend fun getWebhooks(): List<Webhook>

Get the guild's webhooks.

suspend fun getWidget(): GuildWidget

Get the guild widget.

suspend fun leave()

Leave the server.

modifyChannelPositions

suspend fun modifyChannelPositions(positions: List<GuildPosition>)

Modify the order of channels.

modifyRolePositions

suspend fun modifyRolePositions(positions: List<GuildPosition>)

Change role ordering.

open suspend override fun PATCH(majorPath: String, minorPath: String, rateKey: String, omitNulls: Boolean, block: HttpRequestBuilder.() -> Unit): HttpResponse

open suspend override fun POST(majorPath: String, minorPath: String, rateKey: String, omitNulls: Boolean, block: HttpRequestBuilder.() -> Unit): HttpResponse

suspend fun prune(days: Int = 1, includeRoles: List<String>? = null): Pruned

Prune messages with result. Not recommended for large guilds.

pruneWithResult

suspend fun pruneWithResult(days: Int = 1, includeRoles: List<String>? = null)

Prune messages.

open suspend override fun PUT(majorPath: String, minorPath: String, rateKey: String, omitNulls: Boolean, block: HttpRequestBuilder.() -> Unit): HttpResponse

suspend fun removeBan(userId: String)

Unban a user.

suspend fun removeMember(userId: String)

Kick a user from the server.

removeMemberRole

suspend fun removeMemberRole(userId: String, roleId: String)

Remove a role from a user.

syncIntegration

suspend fun syncIntegration(guildIntegrationId: String)

Sync an integration.

suspend fun syncTemplate(templateCode: String): Template

Synchronize a template with the current state of the guild

suspend fun updateEmoji(emojiId: String, emoji: PatchEmoji): Emoji

Update an emoji

suspend fun updateGuild(guild: PatchGuild): Guild

Update this guild.

updateIntegration

suspend fun updateIntegration(guildIntegrationId: String, guildIntegration: PatchGuildIntegration)

Update a guild integration.

suspend fun updateMember(userId: String, guildMember: PatchGuildMember)

Update a guild member.

suspend fun updateRole(roleId: String, role: PatchRole): Role

Update a role.

suspend fun updateSticker(stickerId: String, sticker: PatchSticker): Sticker

Update an existing sticker.

suspend fun updateTemplate(templateCode: String, updateTemplate: UpdateTemplate): Template

Updates a template

suspend fun updateWidget(guildWidget: GuildWidget): GuildWidget

Update the guild widget.