Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActionMetadataModel

Action Metadata is a static Javascript object that describes the action, it is required by Zyllio Studio to display its properties from the Action Editor

Hierarchy

  • ActionMetadataModel

Index

Properties

Properties

category

category: string

Category in which the action is displayed in Zyllio Studio

Optional help

help?: string

Help link

Optional hint

hint?: string

A short 2-3 sentence explanation/hint of the action's main purpose

icon

icon: string

SVG icon displayed in Zyllio Studio

id

id: string

Unique identifier, must be lower case

label

label: string

Label displayed in Zyllio Studio

Optional metadataVersion

metadataVersion?: number

Metadata version

properties

properties: PropertyMetadataModel[]

Properties to configure the action

Optional role

role?: string

Optional runtime role used by the execution engine

Optional supportedRuntime

supportedRuntime?: "frontend" | "backend" | "both"

Runtime compatibility: frontend, backend or both. If omitted, defaults to frontend.

transitions

transitions: string[]

Transitions

Optional translations

translations?: ActionTranslationMetadataModel[]