OnboardingPrompt
Implementation of the Discord Prompt class in Luau
https://discord.com/developers/docs/resources/guild#guild-prompt-object-prompt-prompt-structure
Summary
Properties
Section titled “Properties”The unique identifier for this prompt
OnboardingPrompt.type :: OnboardingPromptType
The type of prompt this is, determines how it is displayed to users
options
Section titled “options” OnboardingPrompt.options :: Option }
Array of options that users can select from this prompt
The title shown to users when displaying this prompt
singleSelect
Section titled “singleSelect”Whether users can only select one option from this prompt
required
Section titled “required”Whether this prompt is required to be answered by users
inOnboarding
Section titled “inOnboarding”Whether this prompt is shown during the onboarding flow
Methods
Section titled “Methods”OnboardingPrompt : sync ( promptData ) -> ()
Responsible for syncing data to this prompt object. This is typically called by the API when this object is created or updated.
Parameters
| promptData: OnboardingPromptObject |
Functions
Section titled “Functions”OnboardingPrompt . new ( promptData ) -> Prompt
Responsible for constructing this class.
Parameters
| promptData: OnboardingPromptObject |
Returns
| Prompt |