PopiiServerSetting

Popii

---

Popii / PopiiServerSetting

Interface: PopiiServerSetting

Defined in: types.ts:401

Properties

id

id: string

Defined in: types.ts:402

---

label

label: string

Defined in: types.ts:403

---

description?

optional description?: string

Defined in: types.ts:404

---

type

type: "number" | "boolean" | "text" | "select" | "channel" | "role" | "richtext" | "multirole" | "multichannel" | "multicommand" | "color" | "duration" | "secret-status" | "computed"

Defined in: types.ts:405

---

options?

optional options?: object[]

Defined in: types.ts:406

label

label: string

value

value: string

---

tokens?

optional tokens?: object[]

Defined in: types.ts:408

Token chips shown above a richtext input. Clicking inserts the token at cursor.

label

label: string

value

value: string

---

default?

optional default?: any

Defined in: types.ts:409

---

category?

optional category?: string

Defined in: types.ts:410

---

pluginId?

optional pluginId?: string

Defined in: types.ts:412

Owning plugin id used to route this field into its focused dashboard workspace.

---

section?

optional section?: string

Defined in: types.ts:414

Stable task-oriented workspace section. Falls back to group/category when omitted.

---

requiredForSetup?

optional requiredForSetup?: boolean

Defined in: types.ts:416

Marks a value as required before the plugin reports ready for a guild.

---

group?

optional group?: string

Defined in: types.ts:418

Optional sub-heading within a category tab. Fields with the same group value are rendered together under a shared label.

---

importance?

optional importance?: "essential" | "recommended" | "advanced"

Defined in: types.ts:420

Controls where a field appears in generated guided setup.

---

dependsOn?

optional dependsOn?: object

Defined in: types.ts:422

Show or enable this field only when another setting matches.

settingId

settingId: string

equals

equals: string | number | boolean

---

visibleWhen?

optional visibleWhen?: object

Defined in: types.ts:423

settingId

settingId: string

equals

equals: string | number | boolean

---

presetRole?

optional presetRole?: string

Defined in: types.ts:425

Semantic role used by setup presets without exposing the setting id.

---

preview?

optional preview?: object

Defined in: types.ts:426

kind

kind: "text" | "color" | "embed" | "message"

title?

optional title?: string

---

help?

optional help?: object

Defined in: types.ts:427

summary

summary: string

href?

optional href?: string

---

restartRequired?

optional restartRequired?: boolean

Defined in: types.ts:428

---

channelTypes?

optional channelTypes?: number[]

Defined in: types.ts:429

---

min?

optional min?: number

Defined in: types.ts:430

---

max?

optional max?: number

Defined in: types.ts:431

---

paragraph?

optional paragraph?: boolean

Defined in: types.ts:432

---

hidden?

optional hidden?: boolean

Defined in: types.ts:434

If true the setting is saved by the route but not rendered as a standard field. Use for custom UI sections that manage the value directly.