Skip to content
Discord Luau

OnboardingOption

Implementation of discords Option object as a Luau builder.

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

Summary

Properties

OnboardingOption.channelIds :: {string}OnboardingOption.roleIds :: {string}OnboardingOption.emojiId :: string?OnboardingOption.emojiName :: string?OnboardingOption.emojiAnimated :: boolean?OnboardingOption.title :: stringOnboardingOption.description :: string?

Methods

OnboardingOption:addChannelId(channelId: string) → OptionOnboardingOption:addRoleId(roleId: string) → OptionOnboardingOption:setEmoji(emojiId: string, emojiName: string, isAnimated: boolean?) → OptionOnboardingOption:setTitle(title: string) → OptionOnboardingOption:setDescription(description: string) → OptionOnboardingOption:build() → JSON

Functions

OnboardingOption.new(resource: { channelIds: { string }?, roleIds: { string }?, emojiId: string?, emojiName: string?, emojiAnimated: boolean?, title: string?, description: string?, }?) → Option

Properties

Section titled “Properties”

channelIds

Section titled “channelIds”
OnboardingOption.channelIds  :: {string}

Array of channel IDs that are associated with this option.

roleIds

Section titled “roleIds”
OnboardingOption.roleIds  :: {string}

Array of role IDs that are associated with this option.

emojiId

Section titled “emojiId”
OnboardingOption.emojiId  :: string?

The ID of the emoji used for this option.

emojiName

Section titled “emojiName”
OnboardingOption.emojiName  :: string?

The name of the emoji used for this option.

emojiAnimated

Section titled “emojiAnimated”
OnboardingOption.emojiAnimated  :: boolean?

Whether the emoji used for this option is animated.

title

Section titled “title”
OnboardingOption.title  :: string

The title displayed for this option.

description

Section titled “description”
OnboardingOption.description  :: string?

The description displayed for this option.

Methods

Section titled “Methods”

addChannelId

Section titled “addChannelId”
OnboardingOption : addChannelId ( channelId )  -> Option

Add a Channel to this option

Parameters

channelId: string

Returns

Option

addRoleId

Section titled “addRoleId”
OnboardingOption : addRoleId ( roleId )  -> Option

Add a Role to this option

Parameters

roleId: string

Returns

Option

setEmoji

Section titled “setEmoji”
OnboardingOption : setEmoji ( emojiId ,  emojiName ,  isAnimated )  -> Option

Sets the emoji of this option.

Parameters

emojiId: string
emojiName: string
isAnimated: boolean?

Returns

Option

setTitle

Section titled “setTitle”
OnboardingOption : setTitle ( title )  -> Option

Sets the title of this option.

Parameters

title: string

Returns

Option

setDescription

Section titled “setDescription”
OnboardingOption : setDescription ( description )  -> Option

Sets the description of this option.

Parameters

description: string

Returns

Option

build

Section titled “build”
OnboardingOption : build ( )  -> JSON

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

Returns

JSON

Functions

Section titled “Functions”

new

Section titled “new”
OnboardingOption . new ( resource )  -> Option

Responsible for creating a new Option.

Parameters

resource: {
{ channelIds: { string } }

Returns

Option