@discord-types/builders/guild/onboarding/onboarding
API reference for @discord-types/builders/guild/onboarding/onboarding
@discord-types/builders/guild/onboarding/onboarding
Types
Onboarding
Raw Type
type Onboarding = Onboarding.Prototype, & {
prompts: {prompt.JSON},
defaultChannelIds: {string},
enabled: boolean,
mode: guildTypes.OnboardingMode
}
Intersection with variants:
Variant 2
Prop | Type | Description |
---|---|---|
prompts | - | |
defaultChannelIds | - | |
enabled | - | |
mode | - |
JSON
Raw Type
type JSON = Onboarding.Prototype.build(nil :: any),
Functions
Onboarding.Prototype.addPrompt
[[ Add a prompt to this onboarding ]]
Function Signature
--[[
Add a prompt to this onboarding
]]
function Onboarding.Prototype.addPrompt(self: Onboarding, prompt: prompt.JSON) -> Onboarding end
Arguments
prompt
Returns
ret1
Onboarding.Prototype.addDefaultChannelId
[[ Add a default channel to this onboarding ]]
Function Signature
--[[
Add a default channel to this onboarding
]]
function Onboarding.Prototype.addDefaultChannelId(self: Onboarding, channelId: string) -> Onboarding end
Arguments
channelId
Returns
ret1
Onboarding.Prototype.setEnabled
[[ Set weather this onboarding is enabled or not. ]]
Function Signature
--[[
Set weather this onboarding is enabled or not.
]]
function Onboarding.Prototype.setEnabled(self: Onboarding, enabled: boolean) -> Onboarding end
Arguments
enabled
Returns
ret1
Onboarding.Prototype.setMode
[[ Set the mode of this onboarding. ]]
Function Signature
--[[
Set the mode of this onboarding.
]]
function Onboarding.Prototype.setMode(self: Onboarding, mode: guildTypes.OnboardingMode) -> Onboarding end
Arguments
mode
Returns
ret1
Onboarding.Prototype.build
[[ Responsible for building the OnboardingObject JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the OnboardingObject JSON that can be parsed by the Discord API.
]]
function Onboarding.Prototype.build(self: Onboarding) -> JSON end
Returns
ret1
Onboarding.Interface.new
[[ Responsible for creating a new Onboarding.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new Onboarding.
\`\`\`lua
\`\`\`
]]
function Onboarding.Interface.new(resource: {
prompts: {prompt.JSON}?,
defaultChannelIds: {string}?,
enabled: boolean?,
mode: guildTypes.OnboardingMode?
}?) -> Onboarding end
Arguments
resource
This field is optional and may not be specified
{prompts: {prompt.JSON}?, defaultChannelIds: {string}?, enabled: boolean?, mode: guildTypes.OnboardingMode?}?
Returns
ret1
Last updated on