Skip to main content

DiscordGuildOnboardingPrompt

@discordeno/bot


Documentation / @discordeno/bot / DiscordGuildOnboardingPrompt

Interface: DiscordGuildOnboardingPrompt

Defined in: packages/types/dist/types/discord/guild.d.ts:505

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

Properties

id

id: string

Defined in: packages/types/dist/types/discord/guild.d.ts:507

ID of the prompt


in_onboarding

in_onboarding: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:519

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: packages/types/dist/types/discord/guild.d.ts:511

Options available within the prompt


required

required: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:517

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


single_select

single_select: boolean

Defined in: packages/types/dist/types/discord/guild.d.ts:515

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


title

title: string

Defined in: packages/types/dist/types/discord/guild.d.ts:513

Title of the prompt


type

type: DiscordGuildOnboardingPromptType

Defined in: packages/types/dist/types/discord/guild.d.ts:509

Type of prompt