RESTAPIGuildOnboardingPrompt

Hierarchy

• _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Omit<APIGuildOnboardingPrompt, guild_id | id | options | title>>>
• Pick<APIGuildOnboardingPrompt, id | title>
  • RESTAPIGuildOnboardingPrompt

Index

Properties

• id
• in_onboarding
• options
• required
• single_select
• title
• type

Properties

inheritedid

id: string

Inherited from Pick.id

Id of the prompt

optionalinheritedin_onboarding

in_onboarding?: boolean

Inherited from _AddUndefinedToPossiblyUndefinedPropertiesOfInterface.in_onboarding

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

options

options: RESTAPIGuildOnboardingPromptOption[]

Options available within the prompt

optionalinheritedrequired

required?: boolean

Inherited from _AddUndefinedToPossiblyUndefinedPropertiesOfInterface.required

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

optionalinheritedsingle_select

single_select?: boolean

Inherited from _AddUndefinedToPossiblyUndefinedPropertiesOfInterface.single_select

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

inheritedtitle

title: string

Inherited from Pick.title

Title of the prompt

optionalinheritedtype

type?: MultipleChoice | Dropdown

Inherited from _AddUndefinedToPossiblyUndefinedPropertiesOfInterface.type

Type of prompt