Class ActionLabels

User-facing labels for this custom workflow action.

Hierarchy

  • ActionLabels

Constructors

constructor

Properties

actionCardContent? actionDescription? actionName appDisplayName? inputFieldDescriptions? inputFieldLabels? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optional actionCardContent

actionCardContent?: string

The label to be displayed in the action card of the workflow editor once this custom action has been added to a workflow.

Optional actionDescription

actionDescription?: string

A description for this custom action. This will show up in the action editor along with the input fields.

actionName

actionName: string

The name of this custom action. This is what will show up when users are selecting an action in the workflows app.

Optional appDisplayName

appDisplayName?: string

The name to be displayed at the top of the action editor in the workflows app.

Optional inputFieldDescriptions

inputFieldDescriptions?: {
    [key: string]: string;
}

A map of input field names to descriptions for the fields. These will show up as tooltips when users are editing your action.

Type declaration

  • [key: string]: string

Optional inputFieldLabels

inputFieldLabels?: {
    [key: string]: string;
}

A map of input field names to the user-facing labels.

Type declaration

  • [key: string]: string

Static Readonly attributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Type declaration

  • baseName: string
  • format: string
  • name: string
  • type: string

Static Readonly discriminator

discriminator: undefined | string = undefined

Methods

Static getAttributeTypeMap

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc