Skip to content

Onboarding

Implementation of discords Onboarding object as a Luau builder.

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

Properties

The Onboarding instance has no set properties!

Methods

The Onboarding instance has no set methods!

Functions

addPrompt

Onboarding . addPrompt (

     self: Onboarding
     prompt: prompt.JSON
)  -> ()

Add a prompt to this onboarding

addDefaultChannelId

Onboarding . addDefaultChannelId (

     self: Onboarding
     channelId: string
)  -> ()

Add a default channel to this onboarding

setEnabled

Onboarding . setEnabled (

     self: Onboarding
     enabled: boolean
)  -> ()

Set weather this onboarding is enabled or not.

setMode

Onboarding . setMode (

     self: Onboarding
     mode: apiTypes.OnboardingMode
)  -> ()

Set the mode of this onboarding.

build

Onboarding . build (

     self: Onboarding
)  -> ()

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

new

Onboarding . new (

     resource: {
      {… prompts: { prompt.JSON …}    }
)  -> ()

Responsible for creating a new Onboarding.