Skip to main content

GuildOnboardingPrompt

Documentation


Documentation / @discordeno/bot / GuildOnboardingPrompt

Interface: GuildOnboardingPrompt

Defined in: transformers/types.ts:1578

Properties

id

id: bigint

Defined in: transformers/types.ts:1580

ID of the prompt


inOnboarding

inOnboarding: boolean

Defined in: transformers/types.ts:1592

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:1584

Options available within the prompt


required

required: boolean

Defined in: transformers/types.ts:1590

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


singleSelect

singleSelect: boolean

Defined in: transformers/types.ts:1588

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


title

title: string

Defined in: transformers/types.ts:1586

Title of the prompt


type

type: DiscordGuildOnboardingPromptType

Defined in: transformers/types.ts:1582

Type of prompt