Skip to main content

DiscordGuildOnboarding

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordGuildOnboarding

Interface: DiscordGuildOnboarding

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

Properties​

default_channel_ids​

default_channel_ids: string[]

Channel IDs that members get opted into automatically

Defined in​

packages/types/dist/types/discord.d.ts:3302

enabled​

enabled: boolean

Whether onboarding is enabled in the guild

Defined in​

packages/types/dist/types/discord.d.ts:3304

guild_id​

guild_id: string

ID of the guild this onboarding is part of

Defined in​

packages/types/dist/types/discord.d.ts:3298

mode​

mode: DiscordGuildOnboardingMode

Current mode of onboarding

Defined in​

packages/types/dist/types/discord.d.ts:3306

prompts​

prompts: DiscordGuildOnboardingPrompt[]

Prompts shown during onboarding and in customize community

Defined in​

packages/types/dist/types/discord.d.ts:3300