Skip to main content

DiscordGuildOnboardingPrompt

Documentation


Documentation / @discordeno/types / DiscordGuildOnboardingPrompt

Interface: DiscordGuildOnboardingPrompt

Defined in: discord/guild.ts:548

https://docs.discord.com/developers/resources/guild#guild-onboarding-object-onboarding-prompt-structure

Properties

id

id: string

Defined in: discord/guild.ts:550

ID of the prompt


in_onboarding

in_onboarding: boolean

Defined in: discord/guild.ts:562

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


options

options: DiscordGuildOnboardingPromptOption[]

Defined in: discord/guild.ts:554

Options available within the prompt


required

required: boolean

Defined in: discord/guild.ts:560

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


single_select

single_select: boolean

Defined in: discord/guild.ts:558

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


title

title: string

Defined in: discord/guild.ts:556

Title of the prompt


type

type: DiscordGuildOnboardingPromptType

Defined in: discord/guild.ts:552

Type of prompt