DiscordGuildOnboarding

Documentation

---

Documentation / @discordeno/types / DiscordGuildOnboarding

Interface: DiscordGuildOnboarding

Defined in: discord/guild.ts:534

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

Properties

default_channel_ids

default_channel_ids: string[]

Defined in: discord/guild.ts:540

Channel IDs that members get opted into automatically

---

enabled

enabled: boolean

Defined in: discord/guild.ts:542

Whether onboarding is enabled in the guild

---

guild_id

guild_id: string

Defined in: discord/guild.ts:536

ID of the guild this onboarding is part of

---

mode

mode: DiscordGuildOnboardingMode

Defined in: discord/guild.ts:544

Current mode of onboarding

---

prompts

prompts: DiscordGuildOnboardingPrompt[]

Defined in: discord/guild.ts:538

Prompts shown during onboarding and in customize community