Onboarding

Implementation of discords Onboarding object as a Luau builder.

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding-json-params

Summary

Properties

Onboarding.prompts :: {Builders.Guild.OnboardingPrompt}Onboarding.defaultChannelIds :: {string}Onboarding.enabled :: booleanOnboarding.mode :: apiTypes.OnboardingMode

Methods

Onboarding:addPrompt(prompt: prompt.JSON) → OnboardingOnboarding:addDefaultChannelId(channelId: string) → OnboardingOnboarding:setEnabled(enabled: boolean) → OnboardingOnboarding:setMode(mode: apiTypes.OnboardingMode) → OnboardingOnboarding:build() → JSON

Functions

Onboarding.new(resource: { prompts: { prompt.JSON }?, defaultChannelIds: { string }?, enabled: boolean?, mode: apiTypes.OnboardingMode?, }?) → Onboarding

Properties

prompts

Onboarding.prompts  :: OnboardingPrompt}

---

Array of prompts shown during onboarding

defaultChannelIds

Onboarding.defaultChannelIds  :: {string}

---

Array of channel IDs that members get opted into automatically

enabled

Onboarding.enabled  :: boolean

---

Whether onboarding is enabled in the guild

mode

Onboarding.mode  :: OnboardingMode

---

Current mode of onboarding

Methods

addPrompt

Onboarding : addPrompt ( prompt )  -> Onboarding

Add a prompt to this onboarding

Parameters

prompt: JSON

Returns

Onboarding

addDefaultChannelId

Onboarding : addDefaultChannelId ( channelId )  -> Onboarding

Add a default channel to this onboarding

Parameters

channelId: string

Returns

Onboarding

setEnabled

Onboarding : setEnabled ( enabled )  -> Onboarding

Set weather this onboarding is enabled or not.

Parameters

enabled: boolean

Returns

Onboarding

setMode

Onboarding : setMode ( mode )  -> Onboarding

Set the mode of this onboarding.

Parameters

mode: OnboardingMode

Returns

Onboarding

build

Onboarding : build ( )  -> JSON

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

Returns

JSON

Functions

new

Onboarding . new ( resource )  -> Onboarding

Responsible for creating a new Onboarding.

Parameters

resource: { { prompts: { prompt.JSON } }

Returns

Onboarding