OnboardingBuilder

OnboardingBuilder allows you to build onboarding for discord guilds.

Usage:

local DiscordLuau = require("../Submodules/DiscordLuau")

local OnboardingBuilder = DiscordLuau.OnboardingBuilder.new()
  :setMode(DiscordLuau.OnboardingBuilder.Mode.Default)
  :setEnabled(true)
  :addChannelId("1048686561685946489")

Properties

Mode

OnboardingBuilder.Mode  :: table

---

An enumeration of onboarding modes

• Default: 0
• Advanced: 1

Methods

toPayloadObject

OnboardingBuilder : toPayloadObject ()  -> Network.Resolvable

Converts the message to a JSON object that can be sent to the Discord API.

setMode

OnboardingBuilder : setMode (

     mode: number

)  -> Builders.OnboardingBuilder

Sets the mode of the Guild onbaording object

setEnabled

OnboardingBuilder : setEnabled (

     isEnabled: boolean

)  -> Builders.OnboardingBuilder

Sets if the guild onboarding is enabled or not

addChannelId

OnboardingBuilder : addChannelId (

     channelId: string

)  -> Builders.OnboardingBuilder

Channel IDs that members get opted into automatically

addOnboardingPrompt

OnboardingBuilder : addOnboardingPrompt (

     prompt: Objects.OnboardingPromptBuilder

)  -> Builders.OnboardingBuilder

Channel IDs that members get opted into automatically

toPayloadObject

OnboardingBuilder : toPayloadObject ()  -> Network.Resolvable

Converts the message to a JSON object that can be sent to the Discord API.

Functions

new

OnboardingBuilder . new ()  -> ()

Creates a new instance of OnboardingBuilder.