Skip to main content

GuildOnboardingPrompt

Documentation


Documentation / @discordeno/bot / GuildOnboardingPrompt

Interface: GuildOnboardingPrompt

Defined in: transformers/types.ts:1579

Properties​

id​

id: bigint

Defined in: transformers/types.ts:1581

ID of the prompt


inOnboarding​

inOnboarding: boolean

Defined in: transformers/types.ts:1593

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


options​

options: GuildOnboardingPromptOption[]

Defined in: transformers/types.ts:1585

Options available within the prompt


required​

required: boolean

Defined in: transformers/types.ts:1591

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


singleSelect​

singleSelect: boolean

Defined in: transformers/types.ts:1589

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


title​

title: string

Defined in: transformers/types.ts:1587

Title of the prompt


type​

type: DiscordGuildOnboardingPromptType

Defined in: transformers/types.ts:1583

Type of prompt