Skip to main content

GuildOnboardingPrompt

@discordeno/bot


Documentation / @discordeno/bot / GuildOnboardingPrompt

Interface: GuildOnboardingPrompt

Defined in: packages/bot/src/transformers/types.ts:1293

Properties

id

id: bigint

Defined in: packages/bot/src/transformers/types.ts:1295

ID of the prompt


inOnboarding

inOnboarding: boolean

Defined in: packages/bot/src/transformers/types.ts:1307

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: packages/bot/src/transformers/types.ts:1299

Options available within the prompt


required

required: boolean

Defined in: packages/bot/src/transformers/types.ts:1305

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


singleSelect

singleSelect: boolean

Defined in: packages/bot/src/transformers/types.ts:1303

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


title

title: string

Defined in: packages/bot/src/transformers/types.ts:1301

Title of the prompt


type

type: DiscordGuildOnboardingPromptType

Defined in: packages/bot/src/transformers/types.ts:1297

Type of prompt