kord-core/dev.kord.core.entity/PartialGuild

PartialGuild

class PartialGuild(val data: PartialGuildData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : GuildBehavior(source)

Constructors

constructor(data: PartialGuildData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

open val activeThreads: Flow<ThreadChannel>

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

approximateMemberCount

val approximateMemberCount: Int?

The approximate number of members in this guild.

approximatePresenceCount

val approximatePresenceCount: Int?

The approximate number of online members in this guild.

autoModerationRules

open val autoModerationRules: Flow<AutoModerationRule>

Requests to get all AutoModerationRules currently configured for this guild.

val banner: Asset?

val bannerHash: String?

open val bans: Flow<Ban>

Requests to get all present bans for this guild.

open val cachedThreads: Flow<ThreadChannel>

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

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.

val data: PartialGuildData

val description: String?

The description of this guild, if present.

open val emojis: Flow<GuildEmoji>

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

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.

val icon: Asset?

val iconHash: String?

The icon hash, if present.

open override val id: Snowflake

The unique identifier of this entity.

open val integrations: Flow<Integration>

Requests to get the integrations of this guild.

open val invites: Flow<InviteWithMetadata>

Requests to get the invites for this guild.

open override val kord: Kord

The kord instance that created this object.

open val members: Flow<Member>

Requests to get all present members in this guild.

val name: String

The name of this guild.

val nsfw: NsfwLevel?

The NSFW Level of this Guild

val owner: Boolean?

wither who created the invite is the owner or not.

val permissions: Permissions?

permissions that the invite creator has, if present.

open val presences: Flow<Presence>

Requests to get all present presences of this guild.

open val regions: Flow<Region>

Requests to get the present voice regions for this guild.

open val roles: Flow<Role>

Requests to get all present roles in the guild.

scheduledEvents

open val scheduledEvents: Flow<GuildScheduledEvent>

val splash: Asset?

val splashHash: String?

open val stickers: Flow<GuildSticker>

open override val supplier: EntitySupplier

The supplier used to request entities.

open val templates: Flow<Template>

val vanityCode: String?

The vanity code of this server used in the vanityUrl, if present.

val vanityUrl: String?

The vanity invite URL of this server, if present.

verificationLevel

val verificationLevel: VerificationLevel?

The verification level required for the guild.

open val voiceStates: Flow<VoiceState>

Requests to get the present voice states of this guild.

open val webhooks: Flow<Webhook>

Requests to get all present webhooks for this guild.

val welcomeScreen: WelcomeScreen?

The welcome screen of a Community guild, shown to new members.

Functions

open suspend fun asGuild(): Guild

Requests to get this behavior as a Guild.

open suspend fun asGuildOrNull(): Guild?

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

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

Requests to ban the given userId in this guild.

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

Compares entities on id.

createApplicationCommands

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

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

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.

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.

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.

open suspend fun delete()

Requests to delete this guild.

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

Requests to edit this guild.

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

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

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

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

open operator override fun equals(other: Any?): Boolean

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.

open suspend fun getBan(userId: Snowflake): Ban

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

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.

open suspend fun getChannel(channelId: Snowflake): GuildChannel

Requests to get the TopGuildChannel represented by the channelId.

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.

suspend fun getGuild(): Guild

Requests to get the full Guild entity for this PartialGuild.

suspend fun getGuildOrNull(): Guild?

Requests to get the Guild for this invite, returns null if the Guild 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.

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.

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.

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

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.

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.

open suspend fun getPruneCount(days: Int = 7): Int

Requests to get the amount of users that would be pruned in this guild.

open suspend fun getRole(roleId: Snowflake): Role

Requests to get the Role represented by the roleId.

open suspend fun getRoleOrNull(roleId: Snowflake): Role?

Requests to get the Role represented by the roleId, returns null if the Role isn't present.

open suspend fun getSticker(stickerId: Snowflake): GuildSticker

getStickerOrNull

open suspend fun getStickerOrNull(stickerId: Snowflake): GuildSticker?

open suspend fun getTemplate(code: String): Template

getTemplateOrNull

open suspend fun getTemplateOrNull(code: String): Template?

open suspend fun getVanityUrl(): String?

Requests to get the vanity url of this guild, if present.

getWelcomeScreen

open suspend fun getWelcomeScreen(): WelcomeScreen

getWelcomeScreenOrNull

open suspend fun getWelcomeScreenOrNull(): WelcomeScreen?

open suspend fun getWidget(): GuildWidget

getWidgetOrNull

open suspend fun getWidgetOrNull(): GuildWidget?

open override fun hashCode(): Int

open suspend fun kick(userId: Snowflake, reason: String? = null)

Requests to kick the given userId.

open suspend fun leave()

Requests to leave this guild.

open suspend fun prune(days: Int = 7, reason: String? = null): Int

Requests to prune users in this guild.

@PrivilegedIntent

open fun requestMembers(request: RequestGuildMembers): Flow<MembersChunkEvent>

Executes the request on this gateway, returning a flow of MembersChunkEvent responses.

@PrivilegedIntent

inline fun GuildBehavior.requestMembers(builder: RequestGuildMembersBuilder.() -> Unit = { requestAllMembers() }): Flow<MembersChunkEvent>

Executes a RequestGuildMembers command configured by the builder for guild on this gateway, returning a flow of MembersChunkEvent responses.

swapChannelPositions

inline suspend fun GuildBehavior.swapChannelPositions(builder: GuildChannelPositionModifyBuilder.() -> Unit)

Requests to swap positions of channels in this guild.

swapRolePositions

inline suspend fun GuildBehavior.swapRolePositions(builder: RolePositionsModifyBuilder.() -> Unit): Flow<Role>

Requests to swap positions of roles in this guild.

open override fun toString(): String

open suspend fun unban(userId: Snowflake, reason: String? = null)

Requests to unban the given userId.

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): PartialGuild

Returns a new GuildBehavior with the given strategy.