Skip to main content

DiscordGuildOnboardingPrompt

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordGuildOnboardingPrompt

Interface: DiscordGuildOnboardingPrompt

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

Properties​

id​

id: string

ID of the prompt

Defined in​

packages/types/dist/types/discord.d.ts:3311

in_onboarding​

in_onboarding: boolean

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

Defined in​

packages/types/dist/types/discord.d.ts:3323

options​

options: DiscordGuildOnboardingPromptOption[]

Options available within the prompt

Defined in​

packages/types/dist/types/discord.d.ts:3315

required​

required: boolean

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

Defined in​

packages/types/dist/types/discord.d.ts:3321

single_select​

single_select: boolean

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

Defined in​

packages/types/dist/types/discord.d.ts:3319

title​

title: string

Title of the prompt

Defined in​

packages/types/dist/types/discord.d.ts:3317

type​

type: DiscordGuildOnboardingPromptType

Type of prompt

Defined in​

packages/types/dist/types/discord.d.ts:3313