DashboardAction

Popii

---

Popii / DashboardAction

Interface: DashboardAction<TInput>

Defined in: plugins/dashboard.ts:72

Type Parameters

TInput

TInput = unknown

Methods

execute()

execute(context, input): Promise<DashboardActionResult>

Defined in: plugins/dashboard.ts:85

Parameters

context

DashboardActionContext

input

TInput

Returns

Promise<DashboardActionResult>

Properties

id

id: string

Defined in: plugins/dashboard.ts:73

---

label

label: string

Defined in: plugins/dashboard.ts:74

---

intent?

optional intent?: "default" | "primary" | "danger"

Defined in: plugins/dashboard.ts:75

---

capability?

optional capability?: DashboardCapability

Defined in: plugins/dashboard.ts:76

---

mutation?

optional mutation?: boolean

Defined in: plugins/dashboard.ts:77

---

idempotent?

optional idempotent?: boolean

Defined in: plugins/dashboard.ts:78

---

concurrency?

optional concurrency?: "none" | "version" | "idempotency-key"

Defined in: plugins/dashboard.ts:79

---

rateLimit?

optional rateLimit?: "discord" | "read" | "write" | "expensive"

Defined in: plugins/dashboard.ts:80

---

confirmation?

optional confirmation?: string

Defined in: plugins/dashboard.ts:81

---

confirmationDetail?

optional confirmationDetail?: object

Defined in: plugins/dashboard.ts:82

title

title: string

description

description: string

confirmLabel

confirmLabel: string

---

fields?

optional fields?: readonly DashboardActionFormField[]

Defined in: plugins/dashboard.ts:83

---

schema

schema: ZodType<TInput>

Defined in: plugins/dashboard.ts:84

---

audit?

optional audit?: DashboardAuditDescriptor

Defined in: plugins/dashboard.ts:86