Skip to main content

@dialstack/sdk / index / MaterializedButton

Interface: MaterializedButton

Defined in: sdk/src/types/button.ts:139

Properties

compatibility

TypeScript
compatibility: ButtonCompatibilityVerdict;

Defined in: sdk/src/types/button.ts:158


label

TypeScript
label: string;

Defined in: sdk/src/types/button.ts:141


override?

TypeScript
optional override?: string | null;

Defined in: sdk/src/types/button.ts:155


override_id?

TypeScript
optional override_id?: string | null;

Defined in: sdk/src/types/button.ts:157

Deprecated

Use override. Retained for backwards compatibility.


position

TypeScript
position: number;

Defined in: sdk/src/types/button.ts:140


source

TypeScript
source: "template" | "override" | "template_overridden" | "model_default";

Defined in: sdk/src/types/button.ts:151

Where this button came from. model_default is a button the device model gets for free because its hardware has no other way to reach the function — it is stored nowhere, so it has neither template_button nor override, but a device override at the same position shadows or suppresses it like any other row.


target

TypeScript
target: ButtonTarget;

Defined in: sdk/src/types/button.ts:143


template_button?

TypeScript
optional template_button?: string | null;

Defined in: sdk/src/types/button.ts:152


template_button_id?

TypeScript
optional template_button_id?: string | null;

Defined in: sdk/src/types/button.ts:154

Deprecated

Use template_button. Retained for backwards compatibility.


type

TypeScript
type: ButtonType;

Defined in: sdk/src/types/button.ts:142