OnboardingPrompt

Implementation of discords Prompt object as a Luau builder.

https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure

Summary

Properties

OnboardingPrompt.options :: { Builders.Message.SelectMenuOption }OnboardingPrompt.type :: apiTypes.OnboardingPromptTypeOnboardingPrompt.title :: stringOnboardingPrompt.singleSelect :: booleanOnboardingPrompt.required :: boolean

Methods

OnboardingPrompt:addOption(option: option.JSON) → PromptOnboardingPrompt:setType(type: apiTypes.OnboardingPromptType) → PromptOnboardingPrompt:setTitle(title: string) → PromptOnboardingPrompt:setSingleSelect(singleSelect: boolean) → PromptOnboardingPrompt:setRequired(required: boolean) → PromptOnboardingPrompt:build() → JSON

Functions

OnboardingPrompt.new(resource: { type: apiTypes.OnboardingPromptType?, options: { option.JSON }?, title: string?, singleSelect: boolean?, required: boolean?, }?) → Prompt

Properties

options

OnboardingPrompt.options  :: SelectMenuOption }

---

The array of options available within this prompt.

type

OnboardingPrompt.type  :: OnboardingPromptType

---

The type of prompt to display.

title

OnboardingPrompt.title  :: string

---

The title of the prompt to display.

singleSelect

OnboardingPrompt.singleSelect  :: boolean

---

Whether users can select only one option or multiple options.

required

OnboardingPrompt.required  :: boolean

---

Whether this prompt is required to be answered or not.

Methods

addOption

OnboardingPrompt : addOption ( option )  -> Prompt

Add an Option to this prompt

Parameters

option: JSON

Returns

Prompt

setType

OnboardingPrompt : setType ( type )  -> Prompt

Set the type of prompt.

Parameters

type: OnboardingPromptType

Returns

Prompt

setTitle

OnboardingPrompt : setTitle ( title )  -> Prompt

Set the title of this prompt

Parameters

title: string

Returns

Prompt

setSingleSelect

OnboardingPrompt : setSingleSelect ( singleSelect )  -> Prompt

Set weather or not users can select one option, or multiple.

Parameters

singleSelect: boolean

Returns

Prompt

setRequired

OnboardingPrompt : setRequired ( required )  -> Prompt

Set weather this option is required or not.

Parameters

required: boolean

Returns

Prompt

build

OnboardingPrompt : build ( )  -> JSON

Responsible for building the PromptObject JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

OnboardingPrompt . new ( resource )  -> Prompt

Responsible for creating a new Prompt.

Parameters

resource: { type: apiTypes.OnboardingPromptType?, options: { option.JSON, }

Returns

Prompt