kord-core/dev.kord.core.behavior/GuildBehavior

GuildBehavior

interface GuildBehavior : KordEntity, Strategizable(source)

The behavior of a Discord Guild.

Inheritors

Guild

PartialGuild

Properties

activeThreads

open val activeThreads: Flow<ThreadChannel>

Returns all active public and private threads in this guild Threads are ordered by their id, in descending order.

autoModerationRules

open val autoModerationRules: Flow<AutoModerationRule>

Requests to get all AutoModerationRules currently configured for this guild.

bans

open val bans: Flow<Ban>

Requests to get all present bans for this guild.

cachedThreads

open val cachedThreads: Flow<ThreadChannel>

Requests to get all threads in this guild that are present in cache.

channels

open val channels: Flow<TopGuildChannel>

Requests to get all present channels in this guild in an unspecified order, call toList().sorted() on the returned Flow to get a consistent order.

emojis

open val emojis: Flow<GuildEmoji>

Requests to get all custom emojis in this guild in an unspecified order.

gateway

open val gateway: Gateway?

Returns the gateway this guild is part of as per the Discord sharding rules. Returns null if no gateway for the shard is present in kord.

abstract val id: Snowflake

The unique identifier of this entity.

integrations

open val integrations: Flow<Integration>

Requests to get the integrations of this guild.

invites

open val invites: Flow<InviteWithMetadata>

Requests to get the invites for this guild.

kord

abstract val kord: Kord

The kord instance that created this object.

members

open val members: Flow<Member>

Requests to get all present members in this guild.

presences

open val presences: Flow<Presence>

Requests to get all present presences of this guild.

regions

open val regions: Flow<Region>

Requests to get the present voice regions for this guild.

roles

open val roles: Flow<Role>

Requests to get all present roles in the guild.

scheduledEvents

open val scheduledEvents: Flow<GuildScheduledEvent>

stickers

open val stickers: Flow<GuildSticker>

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

templates

open val templates: Flow<Template>

voiceStates

open val voiceStates: Flow<VoiceState>

Requests to get the present voice states of this guild.

webhooks

open val webhooks: Flow<Webhook>

Requests to get all present webhooks for this guild.

Functions

asGuild

open suspend fun asGuild(): Guild

Requests to get this behavior as a Guild.

asGuildOrNull

open suspend fun asGuildOrNull(): Guild?

Requests to get this behavior as a Guild, returns null if the guild isn't present.

ban

inline suspend fun GuildBehavior.ban(userId: Snowflake, builder: BanCreateBuilder.() -> Unit)

Requests to ban the given userId in this guild.

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

createApplicationCommands

inline suspend fun GuildBehavior.createApplicationCommands(builder: GuildMultiApplicationCommandBuilder.() -> Unit): Flow<GuildApplicationCommand>

createCategory

inline suspend fun GuildBehavior.createCategory(name: String, builder: CategoryCreateBuilder.() -> Unit = {}): Category

Requests to create a new category.

createChatInputCommand

inline suspend fun GuildBehavior.createChatInputCommand(name: String, description: String, builder: ChatInputCreateBuilder.() -> Unit = {}): GuildChatInputCommand

createEmoji

inline suspend fun GuildBehavior.createEmoji(name: String, image: Image, builder: EmojiCreateBuilder.() -> Unit = {}): GuildEmoji

createForumChannel

inline suspend fun GuildBehavior.createForumChannel(name: String, builder: ForumChannelCreateBuilder.() -> Unit = {}): ForumChannel

createKeywordAutoModerationRule

inline suspend fun GuildBehavior.createKeywordAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: KeywordAutoModerationRuleCreateBuilder.() -> Unit): KeywordAutoModerationRule

Requests to create a new KeywordAutoModerationRule in this guild and returns it.

createKeywordPresetAutoModerationRule

inline suspend fun GuildBehavior.createKeywordPresetAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: KeywordPresetAutoModerationRuleCreateBuilder.() -> Unit): KeywordPresetAutoModerationRule

Requests to create a new KeywordPresetAutoModerationRule in this guild and returns it.

createMediaChannel

inline suspend fun GuildBehavior.createMediaChannel(name: String, builder: MediaChannelCreateBuilder.() -> Unit = {}): MediaChannel

createMemberProfileAutoModerationRule

inline suspend fun GuildBehavior.createMemberProfileAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MemberUpdate, builder: MemberProfileAutoModerationRuleCreateBuilder.() -> Unit): MemberProfileAutoModerationRule

Requests to create a new MemberProfileAutoModerationRule in this guild and returns it.

createMentionSpamAutoModerationRule

inline suspend fun GuildBehavior.createMentionSpamAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: MentionSpamAutoModerationRuleCreateBuilder.() -> Unit): MentionSpamAutoModerationRule

Requests to create a new MentionSpamAutoModerationRule in this guild and returns it.

createMessageCommand

inline suspend fun GuildBehavior.createMessageCommand(name: String, builder: MessageCommandCreateBuilder.() -> Unit = {}): GuildMessageCommand

createNewsChannel

inline suspend fun GuildBehavior.createNewsChannel(name: String, builder: NewsChannelCreateBuilder.() -> Unit = {}): NewsChannel

Requests to create a new news channel.

createRole

inline suspend fun GuildBehavior.createRole(builder: RoleCreateBuilder.() -> Unit = {}): Role

Requests to add a new role to this guild.

createScheduledEvent

suspend fun GuildBehavior.createScheduledEvent(name: String, privacyLevel: GuildScheduledEventPrivacyLevel, scheduledStartTime: Instant, entityType: ScheduledEntityType, builder: ScheduledEventCreateBuilder.() -> Unit): GuildScheduledEvent

Creates a new GuildScheduledEvent.

createSpamAutoModerationRule

inline suspend fun GuildBehavior.createSpamAutoModerationRule(name: String, eventType: AutoModerationRuleEventType = MessageSend, builder: SpamAutoModerationRuleCreateBuilder.() -> Unit): SpamAutoModerationRule

Requests to create a new SpamAutoModerationRule in this guild and returns it.

createStageChannel

inline suspend fun GuildBehavior.createStageChannel(name: String, builder: StageChannelCreateBuilder.() -> Unit = {}): StageChannel

Requests to create a new stage channel.

createSticker

open suspend fun createSticker(name: String, description: String, tags: String, file: NamedFile): GuildSticker

createTextChannel

inline suspend fun GuildBehavior.createTextChannel(name: String, builder: TextChannelCreateBuilder.() -> Unit = {}): TextChannel

Requests to create a new text channel.

createUserCommand

inline suspend fun GuildBehavior.createUserCommand(name: String, builder: UserCommandCreateBuilder.() -> Unit = {}): GuildUserCommand

createVoiceChannel

inline suspend fun GuildBehavior.createVoiceChannel(name: String, builder: VoiceChannelCreateBuilder.() -> Unit = {}): VoiceChannel

Requests to create a new voice channel.

delete

open suspend fun delete()

Requests to delete this guild.

edit

inline suspend fun GuildBehavior.edit(builder: GuildModifyBuilder.() -> Unit): Guild

Requests to edit this guild.

editMFALevel

open suspend fun editMFALevel(level: MFALevel, reason: String? = null): MFALevel

Requests to edit this guild's MFA level and returns the updated level.

editOnboarding

inline suspend fun GuildBehavior.editOnboarding(builder: GuildOnboardingModifyBuilder.() -> Unit): GuildOnboarding

Requests to edit the GuildOnboarding object of the guild and returns the edited onboarding object.

editSelfNickname

open suspend fun editSelfNickname(newNickname: String? = null, reason: String? = null): String

Requests to change the nickname of the bot in this guild, passing null will remove it.

editWelcomeScreen

open suspend fun editWelcomeScreen(builder: WelcomeScreenModifyBuilder.() -> Unit): WelcomeScreen

editWidget

inline suspend fun GuildBehavior.editWidget(builder: GuildWidgetModifyBuilder.() -> Unit): GuildWidget

fetchGuild

open suspend fun fetchGuild(): Guild

Retrieve the Guild associated with this behaviour from the provided EntitySupplier

fetchGuildOrNull

open suspend fun fetchGuildOrNull(): Guild?

Retrieve the Guild associated with this behaviour from the provided EntitySupplier returns null if the Guild isn't present.

getApplicationCommand

open suspend fun getApplicationCommand(commandId: Snowflake): GuildApplicationCommand

getApplicationCommandOf

inline suspend fun <T : GuildApplicationCommand> GuildBehavior.getApplicationCommandOf(commandId: Snowflake): T

getApplicationCommandOfOrNull

inline suspend fun <T : GuildApplicationCommand> GuildBehavior.getApplicationCommandOfOrNull(commandId: Snowflake): T?

getApplicationCommandOrNull

open suspend fun getApplicationCommandOrNull(commandId: Snowflake): GuildApplicationCommand?

getApplicationCommands

open fun getApplicationCommands(withLocalizations: Boolean? = null): Flow<GuildApplicationCommand>

getAuditLogEntries

inline fun GuildBehavior.getAuditLogEntries(builder: AuditLogGetRequestBuilder.() -> Unit = {}): Flow<AuditLogEntry>

The Audit log entries from this guild, configured by the builder.

getAutoModerationRule

open suspend fun getAutoModerationRule(ruleId: Snowflake): AutoModerationRule

Requests an AutoModerationRule by its id.

getAutoModerationRuleOrNull

open suspend fun getAutoModerationRuleOrNull(ruleId: Snowflake): AutoModerationRule?

Requests an AutoModerationRule by its id. Returns null if it wasn't found.

getBan

open suspend fun getBan(userId: Snowflake): Ban

Requests to get the Ban of the User represented by the userId.

getBanOrNull

open suspend fun getBanOrNull(userId: Snowflake): Ban?

Requests to get the Ban of the User represented by the userId, returns null if the Ban isn't present.

getChannel

open suspend fun getChannel(channelId: Snowflake): GuildChannel

Requests to get the TopGuildChannel represented by the channelId.

getChannelOf

inline suspend fun <T : GuildChannel> GuildBehavior.getChannelOf(channelId: Snowflake): T

Requests to get the GuildChannel represented by the channelId as type T.

getChannelOfOrNull

inline suspend fun <T : GuildChannel> GuildBehavior.getChannelOfOrNull(channelId: Snowflake): T?

Requests to get the GuildChannel represented by the channelId as type T, returns null if the GuildChannel isn't present.

getChannelOrNull

open suspend fun getChannelOrNull(channelId: Snowflake): GuildChannel?

Requests to get the GuildChannel represented by the channelId, returns null if the GuildChannel isn't present.

getGuildScheduledEvent

open suspend fun getGuildScheduledEvent(eventId: Snowflake): GuildScheduledEvent

Requests a GuildScheduledEvent by its id.

getGuildScheduledEventOrNull

open suspend fun getGuildScheduledEventOrNull(eventId: Snowflake): GuildScheduledEvent?

Requests a GuildScheduledEvent by its id returns null if none could be found.

getInvite

open suspend fun getInvite(code: String, withCounts: Boolean = true, withExpiration: Boolean = true, scheduledEventId: Snowflake? = null): Invite

Requests to get the Invite represented by the code.

getInviteOrNull

open suspend fun getInviteOrNull(code: String, withCounts: Boolean = true, withExpiration: Boolean = true, scheduledEventId: Snowflake? = null): Invite?

Requests to get the Invite represented by the code, returns null if the Invite isn't present.

getMember

open suspend fun getMember(userId: Snowflake): Member

Requests to get the Member represented by the userId.

getMemberOrNull

open suspend fun getMemberOrNull(userId: Snowflake): Member?

Requests to get the Member represented by the userId, returns null if the Member isn't present.

getMembers

@KordExperimental

open fun getMembers(query: String, limit: Int = 1000): Flow<Member>

Requests to get up to limit members whose Member.username or Member.nickname match the query. The limit accepts a maximum value of 1000 and a minimum of 1.

getOnboarding

open suspend fun getOnboarding(): GuildOnboarding

Requests the onboarding object for this guild.

getOnboardingOrNull

open suspend fun getOnboardingOrNull(): GuildOnboarding?

Requests the onboarding object for this guild. Returns null if it wasn't found.

getPreview

open suspend fun getPreview(): GuildPreview

Returns the preview of this guild. The bot does not need to present in this guild for this to complete successfully.

getPreviewOrNull

open suspend fun getPreviewOrNull(): GuildPreview?

Returns the preview of this guild. The bot does not need to present in this guild for this to complete successfully. Returns null if the preview doesn't exist.

getPruneCount