Skip to main content

DiscordGuildOnboardingPromptOption

@discordeno/botDocs


Documentation / @discordeno/bot / DiscordGuildOnboardingPromptOption

Interface: DiscordGuildOnboardingPromptOption

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

Properties

channel_ids

channel_ids: string[]

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

Defined in

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


description

description: null | string

Description of the option

Defined in

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


emoji?

optional emoji: DiscordEmoji

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.

Defined in

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


emoji_animated?

optional emoji_animated: boolean

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.

Defined in

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


emoji_id?

optional emoji_id: string

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.

Defined in

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


emoji_name?

optional emoji_name: string

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.

Defined in

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


id

id: string

ID of the prompt option

Defined in

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


role_ids

role_ids: string[]

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

Defined in

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


title

title: string

Title of the option

Defined in

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