Skip to main content

DiscordGuildOnboardingPromptOption

@discordeno/bot


Documentation / @discordeno/bot / DiscordGuildOnboardingPromptOption

Interface: DiscordGuildOnboardingPromptOption

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

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

Properties

channel_ids

channel_ids: string[]

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

IDs for channels a member is added to when the option is selected


description

description: null | string

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

Description of the option


emoji?

optional emoji: DiscordEmoji

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

Emoji of the option

Remarks

When creating or updating a prompt option, the emoji_id, emoji_name, and emoji_animated fields must be used instead of the emoji object.


emoji_animated?

optional emoji_animated: boolean

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

Whether the emoji is animated

Remarks

When creating or updating a prompt option, the emoji_id, emoji_name, and emoji_animated fields must be used instead of the emoji object.


emoji_id?

optional emoji_id: string

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

Emoji ID of the option

Remarks

When creating or updating a prompt option, the emoji_id, emoji_name, and emoji_animated fields must be used instead of the emoji object.


emoji_name?

optional emoji_name: string

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

Emoji name of the option

Remarks

When creating or updating a prompt option, the emoji_id, emoji_name, and emoji_animated fields must be used instead of the emoji object.


id

id: string

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

ID of the prompt option


role_ids

role_ids: string[]

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

IDs for roles assigned to a member when the option is selected


title

title: string

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

Title of the option