Skip to main content

DiscordGuildOnboarding

@discordeno/bot

Documentation / @discordeno/bot / DiscordGuildOnboarding

Interface: DiscordGuildOnboarding

Defined in: packages/types/dist/types/discord.d.ts:3299

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

Properties​

default_channel_ids​

default_channel_ids: string[]

Defined in: packages/types/dist/types/discord.d.ts:3305

Channel IDs that members get opted into automatically

enabled​

enabled: boolean

Defined in: packages/types/dist/types/discord.d.ts:3307

Whether onboarding is enabled in the guild

guild_id​

guild_id: string

Defined in: packages/types/dist/types/discord.d.ts:3301

ID of the guild this onboarding is part of

mode​

mode: DiscordGuildOnboardingMode

Defined in: packages/types/dist/types/discord.d.ts:3309

Current mode of onboarding

prompts​

prompts: DiscordGuildOnboardingPrompt[]

Defined in: packages/types/dist/types/discord.d.ts:3303

Prompts shown during onboarding and in customize community