kord-core/dev.kord.core.entity/GuildOnboarding

GuildOnboarding

class GuildOnboarding(val data: DiscordGuildOnboarding, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordObject, Strategizable(source)

Represents the onboarding flow for a Guild.

Constructors

Link copied to clipboard
constructor(data: DiscordGuildOnboarding, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Types

Link copied to clipboard
class Prompt(val data: DiscordOnboardingPrompt, val guildId: Snowflake, val kord: Kord) : KordEntity

Represents a prompt for a GuildOnboarding.

Properties

Link copied to clipboard
Link copied to clipboard
val defaultChannelBehaviors: List<TopGuildChannelBehavior>

The behaviors of the channels that Members get opted into automatically.

Link copied to clipboard
val defaultChannelIds: List<Snowflake>

The IDs of the channels that Members get opted into automatically.

Link copied to clipboard
val defaultChannels: Flow<TopGuildChannel>

Requests the channels that Members get opted into automatically.

Link copied to clipboard
val guild: GuildBehavior

The behavior of the Guild this onboarding is part of.

Link copied to clipboard
val guildId: Snowflake

The ID of the Guild this onboarding is part of.

Link copied to clipboard
val isEnabled: Boolean

Whether onboarding is enabled in the guild.

Link copied to clipboard
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
val mode: OnboardingMode

Current mode of onboarding.

Link copied to clipboard
val prompts: List<GuildOnboarding.Prompt>

The Prompts shown during onboarding and in customize community.

Link copied to clipboard
open override val supplier: EntitySupplier

The supplier used to request entities.

Functions

Link copied to clipboard
suspend fun getGuild(): Guild

Requests the Guild this onboarding is part of.

Link copied to clipboard
suspend fun getGuildOrNull(): Guild?

Requests the Guild this onboarding is part of, returns null when the guild isn't present.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildOnboarding

Returns a copy of this class with a new supplier provided by the strategy.