@discord-types/builders/guild/onboarding/option
API reference for @discord-types/builders/guild/onboarding/option
@discord-types/builders/guild/onboarding/option
Types
Option
Raw Type
type Option = Option.Prototype, & {
channelIds: {string},
roleIds: {string},
emojiId: string?,
emojiName: string?,
emojiAnimated: boolean?,
title: string,
description: string?
}
Intersection with variants:
Variant 2
JSON
Raw Type
type JSON = Option.Prototype.build(nil :: any),
Functions
Option.Prototype.addChannelId
[[ Add a Channel to this option ]]
Function Signature
--[[
Add a Channel to this option
]]
function Option.Prototype.addChannelId(self: Option, channelId: string) -> Option end
Arguments
channelId
Returns
ret1
Option.Prototype.addRoleId
[[ Add a Role to this option ]]
Function Signature
--[[
Add a Role to this option
]]
function Option.Prototype.addRoleId(self: Option, roleId: string) -> Option end
Arguments
roleId
Returns
ret1
Option.Prototype.setEmoji
[[ Sets the emoji of this option. ]]
Function Signature
--[[
Sets the emoji of this option.
]]
function Option.Prototype.setEmoji(self: Option, emojiId: string, emojiName: string, isAnimated: boolean?) -> Option end
Arguments
emojiId
emojiName
isAnimated
This field is optional and may not be specified
Returns
ret1
Option.Prototype.setTitle
[[ Sets the title of this option. ]]
Function Signature
--[[
Sets the title of this option.
]]
function Option.Prototype.setTitle(self: Option, title: string) -> Option end
Arguments
title
Returns
ret1
Option.Prototype.setDescription
[[ Sets the description of this option. ]]
Function Signature
--[[
Sets the description of this option.
]]
function Option.Prototype.setDescription(self: Option, description: string) -> Option end
Arguments
description
Returns
ret1
Option.Prototype.build
[[ Responsible for building the OptionObject JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the OptionObject JSON that can be parsed by the Discord API.
]]
function Option.Prototype.build(self: Option) -> JSON end
Returns
ret1
Option.Interface.new
[[ Responsible for creating a new Option.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new Option.
\`\`\`lua
\`\`\`
]]
function Option.Interface.new(resource: {
channelIds: {string}?,
roleIds: {string}?,
emojiId: string?,
emojiName: string?,
emojiAnimated: boolean?,
title: string?,
description: string?
}?) -> Option end
Arguments
resource
This field is optional and may not be specified
{channelIds: {string}?, roleIds: {string}?, emojiId: string?, emojiName: string?, emojiAnimated: boolean?, title: string?, description: string?}?
Returns
ret1
Last updated on