Skip to main content

GuildOnboardingPrompt

@discordeno/botDocs


Documentation / @discordeno/bot / GuildOnboardingPrompt

Interface: GuildOnboardingPrompt

Properties

id

id: bigint

ID of the prompt

Defined in

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


inOnboarding

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


options

options: GuildOnboardingPromptOption[]

Options available within the prompt

Defined in

packages/bot/src/transformers/types.ts:1299


required

required: boolean

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

Defined in

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


singleSelect

singleSelect: boolean

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

Defined in

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


title

title: string

Title of the prompt

Defined in

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


type

type: DiscordGuildOnboardingPromptType

Type of prompt

Defined in

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