Skip to main content

DiscordGuildOnboardingPromptOption

Documentation


Documentation / @discordeno/types / DiscordGuildOnboardingPromptOption

Interface: DiscordGuildOnboardingPromptOption

Defined in: discord/guild.ts:566

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

Properties

channel_ids

channel_ids: string[]

Defined in: discord/guild.ts:570

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


description

description: string | null

Defined in: discord/guild.ts:604

Description of the option


emoji?

optional emoji?: DiscordEmoji

Defined in: discord/guild.ts:579

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: discord/guild.ts:600

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: discord/guild.ts:586

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: discord/guild.ts:593

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: discord/guild.ts:568

ID of the prompt option


role_ids

role_ids: string[]

Defined in: discord/guild.ts:572

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


title

title: string

Defined in: discord/guild.ts:602

Title of the option