kord-rest/dev.kord.rest.builder.guild/OnboardingPromptBuilder

OnboardingPromptBuilder

class OnboardingPromptBuilder(var type: OnboardingPromptType, var title: String, var singleSelect: Boolean, var required: Boolean, var inOnboarding: Boolean) : RequestBuilder<OnboardingPromptRequest> (source)

Constructors

OnboardingPromptBuilder

constructor(type: OnboardingPromptType, title: String, singleSelect: Boolean, required: Boolean, inOnboarding: Boolean)

Properties

var id: Snowflake?

The ID of the prompt.

var inOnboarding: Boolean

Indicates whether the prompt is present in the onboarding flow. If false, the prompt will only appear in the Channels & Roles tab.

val options: MutableList<OnboardingPromptOptionBuilder>

The options available within the prompt.

var required: Boolean

Indicates whether the prompt is required before a user completes the onboarding flow.

var singleSelect: Boolean

Indicates whether users are limited to selecting one option for the prompt.

var title: String

The title of the prompt.

var type: OnboardingPromptType

The type of the prompt.

Functions

inline fun OnboardingPromptBuilder.option(title: String, builder: OnboardingPromptOptionBuilder.() -> Unit)

Add an option to options.

open override fun toRequest(): OnboardingPromptRequest