• Home
• dev.kord
• kord-core-jvm
• 0.15.0
• source code
• Guild.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.entity.Guild.kt Maven / Gradle / Ivy

package dev.kord.core.entity

import dev.kord.common.Locale
import dev.kord.common.entity.*
import dev.kord.common.entity.optional.orElse
import dev.kord.common.entity.optional.orEmpty
import dev.kord.common.entity.optional.unwrap
import dev.kord.common.entity.optional.value
import dev.kord.common.exception.RequestException
import dev.kord.core.Kord
import dev.kord.core.behavior.GuildBehavior
import dev.kord.core.behavior.MemberBehavior
import dev.kord.core.behavior.RoleBehavior
import dev.kord.core.behavior.channel.TextChannelBehavior
import dev.kord.core.behavior.channel.TopGuildChannelBehavior
import dev.kord.core.behavior.channel.TopGuildMessageChannelBehavior
import dev.kord.core.behavior.channel.VoiceChannelBehavior
import dev.kord.core.cache.data.GuildData
import dev.kord.core.entity.channel.TextChannel
import dev.kord.core.entity.channel.TopGuildChannel
import dev.kord.core.entity.channel.TopGuildMessageChannel
import dev.kord.core.entity.channel.VoiceChannel
import dev.kord.core.exception.EntityNotFoundException
import dev.kord.core.hash
import dev.kord.core.supplier.EntitySupplier
import dev.kord.core.supplier.EntitySupplyStrategy
import dev.kord.core.supplier.getChannelOfOrNull
import dev.kord.core.switchIfEmpty
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.flow
import kotlinx.datetime.Instant
import kotlin.time.Duration

/**
 * An instance of a [Discord Guild](https://discord.com/developers/docs/resources/guild).
 */
public class Guild(
    public val data: GuildData,
    override val kord: Kord,
    override val supplier: EntitySupplier = kord.defaultSupplier,
) : GuildBehavior {

    override val id: Snowflake get() = data.id

    /**
     * The id of the afk voice channel, if present.
     */
    public val afkChannelId: Snowflake? get() = data.afkChannelId

    override suspend fun asGuild(): Guild = this

    override suspend fun asGuildOrNull(): Guild = this

    public val afkChannel: VoiceChannelBehavior?
        get() = afkChannelId?.let { VoiceChannelBehavior(guildId = id, id = it, kord = kord) }

    /**
     * The afk timeout.
     */
    public val afkTimeout: Duration get() = data.afkTimeout

    /**
     *  The id of the guild creator if it is bot-created.
     */
    public val applicationId: Snowflake? get() = data.applicationId

    /**
     * The approximate number of members in this guild. Present if this guild was requested through
     * [rest][dev.kord.rest.service.RestClient] with the flag `with_counts`.
     */
    public val approximateMemberCount: Int? get() = data.approximateMemberCount.value

    /**
     * The approximate number of online members in this guild. Present if this guild was requested through
     * [rest][dev.kord.rest.service.RestClient] with the flag `with_counts`.
     */
    public val approximatePresenceCount: Int? get() = data.approximatePresenceCount.value

    /**
     * The maximum number of presences for this guild. 25000 By default.
     */
    public val maxPresences: Int get() = data.maxPresences.orElse(25_000)

    /**
     * The maximum number of members for this guild.
     */
    public val maxMembers: Int? get() = data.maxMembers.value

    /**
     * Total permissions of the bot in the Guild (excludes channel overrides).
     *
     * This field is only present if this guild was fetched through [Kord.guilds] with a
     * [EntitySupplyStrategy.rest].
     */
    public val permissions: Permissions? get() = data.permissions.value

    /**
     * The server boost level.
     */
    public val premiumTier: PremiumTier get() = data.premiumTier

    /**
     * The number of boosts this guild has, if present.
     */
    public val premiumSubscriptionCount: Int? get() = data.premiumSubscriptionCount.value

    /**
     * The banner hash, if present.
     */
    public val bannerHash: String? get() = data.banner

    public val banner: Asset? get() = bannerHash?.let { Asset.guildBanner(id, it, kord) }

    /**
     * The ids of all [channels][TopGuildChannel].
     */
    public val channelIds: Set get() = data.channels.orEmpty().toSet()

    /**
     * The explicit content filter level.
     */
    public val contentFilter: ExplicitContentFilter get() = data.explicitContentFilter

    /**
     * The description of this guild, if present.
     */
    public val description: String? get() = data.description

    /**
     * Whether this guild has enabled its widget.
     */
    public val isWidgetEnabled: Boolean get() = data.widgetEnabled.discordBoolean

    /**
     * The ID of the channel the widget will redirect users to, if present.
     */
    public val widgetChannelId: Snowflake? get() = data.widgetChannelId.value

    /**
     * The behavior of the channel widgets will redirect users to, if present.
     */
    public val widgetChannel: TopGuildChannelBehavior?
        get() = widgetChannelId?.let { TopGuildChannelBehavior(guildId = id, id = it, kord = kord) }

    /**
     * The ids of custom emojis in this guild.
     */
    public val emojiIds: Set get() = data.emojis.toSet()

    /**
     * The behavior of the @everyone role.
     */
    public val everyoneRole: RoleBehavior get() = RoleBehavior(id, id, kord)

    /**
     * The enabled guild features.
     */
    public val features: Set get() = data.features.toSet()

    /**
     * The icon hash, if present.
     */
    public val iconHash: String? get() = data.icon

    public val icon: Asset? get() = iconHash?.let { Asset.guildIcon(id, it, kord) }

    /**
     * The time at which this guild was joined, if present.
     */
    public val joinedTime: Instant? get() = data.joinedAt.value

    /**
     * The id of the owner.
     */
    public val ownerId: Snowflake get() = data.ownerId

    /**
     * Whether this bot is the owner of the server
     */
    public val isOwner: Boolean get() = ownerId == kord.selfId

    /**
     * True if the guild is considered large, if present.
     *
     * This field is only present on Guilds created through [dev.kord.core.event.guild.GuildCreateEvent].
     */
    public val isLarge: Boolean? get() = data.large.value

    /**
     * The behavior of the owner.
     */
    public val owner: MemberBehavior get() = MemberBehavior(guildId = id, id = ownerId, kord = kord)

    /**
     * The number of members in the guild, if present.
     *
     *  > This value is only present when the [Kord.cache] stores guilds and the client has been logged in. It
     *  will not be updated throughout the lifetime of the gateway and should thus be seen as an approximation rather
     *  than a precise value.
     */
    public val memberCount: Int? get() = data.memberCount.value

    /**
     * The required multi-factor authentication level of this guild.
     */
    public val mfaLevel: MFALevel get() = data.mfaLevel

    /**
     * The name of this guild.
     */
    public val name: String get() = data.name

    /**
     * the id of the channel where guild notices such as welcome messages and boost events are posted.
     */
    public val publicUpdatesChannelId: Snowflake? get() = data.publicUpdatesChannelId

    /**
     * The behavior of the channel where guild notices such as welcome messages and boost events are posted.
     */
    public val publicUpdatesChannel: TopGuildMessageChannelBehavior?
        get() = publicUpdatesChannelId?.let {
            TopGuildMessageChannelBehavior(guildId = id, id = it, kord = kord)
        }

    public val preferredLocale: Locale get() = Locale.fromString(data.preferredLocale)

    /**
     * The behaviors of all [channels][TopGuildChannel].
     */
    public val channelBehaviors: Set
        get() = data.channels.orEmpty().asSequence().map { TopGuildChannelBehavior(id = it, guildId = id, kord = kord) }
            .toSet()

    /**
     * The default message notification level.
     */
    public val defaultMessageNotificationLevel: DefaultMessageNotificationLevel get() = data.defaultMessageNotifications


    /**
     * The voice region id for the guild.
     */
    @Suppress("DEPRECATION")
    @Deprecated(
        "The region field has been moved to Channel#rtcRegion in Discord API v9",
        ReplaceWith("Channel#rtcRegion")
    )
    public val regionId: String
        get() = data.region

    /**
     * The id of the channel in which a discoverable server's rules should be found
     **/
    public val rulesChannelId: Snowflake? get() = data.rulesChannelId

    /**
     * The channel behavior in which a discoverable server's rules should be found.
     **/
    public val rulesChannel: TopGuildMessageChannelBehavior?
        get() = data.rulesChannelId?.let {
            TopGuildMessageChannelBehavior(id, it, kord)
        }

    /**
     * The splash hash, if present.
     */
    public val splashHash: String? get() = data.splash.value

    public val splash: Asset? get() = splashHash?.let { Asset.guildSplash(id, it, kord) }

    /**
     * The hash of the discovery splash, if present.
     */
    public val discoverySplashHash: String? get() = data.discoverySplash.value

    public val discoverySplash: Asset? get() = discoverySplashHash?.let { Asset.guildDiscoverySplash(id, it, kord) }

    /**
     * The id of the channel to which system messages are sent.
     */
    public val systemChannelId: Snowflake? get() = data.systemChannelId

    /**
     * The behavior of the channel to which system messages are sent.
     */
    public val systemChannel: TextChannelBehavior?
        get() = systemChannelId?.let {
            TextChannelBehavior(guildId = id, id = it, kord = kord)
        }

    public val systemChannelFlags: SystemChannelFlags get() = data.systemChannelFlags

    /**
     * The verification level required for the guild.
     */
    public val verificationLevel: VerificationLevel get() = data.verificationLevel

    /**
     * The ids of the roles.
     */
    public val roleIds: Set get() = data.roles.asSequence().map { it }.toSet()

    /**
     * The behaviors of the [roles][Role].
     */
    public val roleBehaviors: Set
        get() = data.roles.asSequence().map { RoleBehavior(id = it, guildId = id, kord = kord) }.toSet()

    /**
     * The vanity code of this server used in the [vanityUrl], if present.
     */
    public val vanityCode: String? get() = data.vanityUrlCode

    /**
     * The vanity invite URL of this server, if present.
     */
    public val vanityUrl: String? get() = data.vanityUrlCode?.let { "https://discord.gg/$it" }


    /**
     * The maximum amount of users in a video channel, if present.
     */
    public val maxVideoChannelUsers: Int? get() = data.maxVideoChannelUsers.value

    /**
     * The maximum amount of users in a stage video channel, if present.
     */
    public val maxStageVideoChannelUsers: Int? get() = data.maxStageVideoChannelUsers.value

    /**
     * The welcome screen of a Community guild, shown to new members, returned in an [Invite]'s guild object
     */
    public val welcomeScreen: WelcomeScreen? get() = data.welcomeScreen.unwrap { WelcomeScreen(it, kord) }

    /**
     * The [NSFW Level](https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level) of this Guild
     */
    public val nsfw: NsfwLevel get() = data.nsfwLevel

    public val premiumProgressBarEnabled: Boolean get() = data.premiumProgressBarEnabled

    /** The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord. */
    public val safetyAlertsChannelId: Snowflake? get() = data.safetyAlertsChannelId

    /**
     * The behavior of the channel where admins and moderators of Community guilds receive safety alerts from Discord.
     */
    public val safetyAlertsChannel: TextChannelBehavior?
        get() = safetyAlertsChannelId?.let { TextChannelBehavior(guildId = id, id = it, kord) }

    public val stageInstances: Set
        get() = data.stageInstances.orEmpty().map { StageInstance(it, kord) }.toSet()

    override val stickers: Flow
        get() = flow {
            for (sticker in data.stickers.orEmpty()) emit(GuildSticker(sticker, kord))
        }.switchIfEmpty(super.stickers)


    /**
     * Requests to get the [VoiceChannel] represented by the [afkChannelId],
     * returns null if the [afkChannelId] isn't present or the channel itself isn't present.
     *
     * @throws [RequestException] if anything went wrong during the request.
     * @throws [EntityNotFoundException] if the [VoiceChannel] wasn't present.
     */
    public suspend fun getAfkChannel(): VoiceChannel? = afkChannelId?.let { supplier.getChannelOfOrNull(it) }

    /**
     * Requests to get the [TopGuildChannel] represented by the [widgetChannelId],
     * returns null if the [TopGuildChannel] isn't present or [widgetChannelId] is null.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getEmbedChannel(): TopGuildChannel? = widgetChannelId?.let { supplier.getChannelOfOrNull(it) }

    /**
     * Requests to get the [GuildEmoji] represented by the [emojiId] in this guild.
     *
     * @throws [RequestException] if anything went wrong during the request.
     * @throws [EntityNotFoundException] if the [GuildEmoji] wasn't present.
     */
    public suspend fun getEmoji(emojiId: Snowflake): GuildEmoji =
        supplier.getEmoji(guildId = id, emojiId = emojiId)

    /**
     * Requests to get the [GuildEmoji] represented by the [emojiId] in this guild,
     * returns null if the [GuildEmoji] isn't present.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getEmojiOrNull(emojiId: Snowflake): GuildEmoji? =
        supplier.getEmojiOrNull(guildId = id, emojiId = emojiId)


    /**
     * Requests to get the `@everyone` [Role].
     *
     * @throws [RequestException] if anything went wrong during the request.
     * @throws [EntityNotFoundException] if the [Role] wasn't present.
     */
    public suspend fun getEveryoneRole(): Role = supplier.getRole(id, id)

    /**
     * Requests to get the `@everyone` [Role],
     * returns null if the [Role] isn't present.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getEveryoneRoleOrNull(): Role? = supplier.getRoleOrNull(id, id)

    /**
     * Requests to get the owner of this guild as a [Member].
     *
     * @throws [RequestException] if anything went wrong during the request.
     * @throws [EntityNotFoundException] if the [Member] wasn't present.
     */
    public suspend fun getOwner(): Member = supplier.getMember(id, ownerId)

    /**
     * Requests to get the owner of this guild as a [Member],
     * returns null if the [Member] isn't present.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getOwnerOrNull(): Member? = supplier.getMemberOrNull(id, ownerId)

    /**
     * Requests to get The channel where guild notices such as welcome messages and boost events are posted.
     */
    public suspend fun getPublicUpdatesChannel(): TopGuildMessageChannel? = publicUpdatesChannel?.asChannel()

    /**
     * Requests to get the channel in which a discoverable server's rules should be found represented,
     * returns null if the [TopGuildMessageChannel] isn't present, or [rulesChannelId] is null.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getRulesChannel(): TopGuildMessageChannel? = rulesChannel?.asChannel()

    /**
     * Requests to get the channel where system messages (member joins, server boosts, etc.) are sent,
     * returns null if the [TextChannel] isn't present or the [systemChannelId] is null.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getSystemChannel(): TextChannel? =
        systemChannelId?.let { supplier.getChannelOfOrNull(it) }

    /**
     * Requests to get the channel the widget will redirect users to,
     * returns null if the [TextChannel] isn't present or the [widgetChannelId] is null.
     *
     * @throws [RequestException] if anything went wrong during the request.
     */
    public suspend fun getWidgetChannel(): TopGuildMessageChannel? =
        widgetChannelId?.let { supplier.getChannelOfOrNull(it) }

    /**
     * Returns a new [Guild] with the given [strategy].
     */
    override fun withStrategy(strategy: EntitySupplyStrategy<*>): Guild = Guild(data, kord, strategy.supply(kord))

    override fun hashCode(): Int = hash(id)

    override fun equals(other: Any?): Boolean = when (other) {
        is GuildBehavior -> other.id == id
        else -> false
    }

    override fun toString(): String {
        return "Guild(data=$data, kord=$kord, supplier=$supplier)"
    }

}