Preview deployment

class GuildOnboarding

extends

Base
export class GuildOnboarding extends Base

Represents the onboarding data of a guild.

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

defaultChannels : Collection<Snowflake, GuildChannel>

The ids of the channels that new members get opted into automatically

enabled : boolean

Whether onboarding is enabled

readonly
guild : Guild

The guild this onboarding is from

guildId : Snowflake

The id of the guild this onboarding data is for

mode : GuildOnboardingMode

The mode of this onboarding

prompts : Collection<Snowflake, GuildOnboardingPrompt>

The prompts shown during onboarding and in customize community

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

valueOf() : string

Inherited from: Base