Interface Workflow

See: relevant section in reference guide

interface Workflow {
    $CreationOptions?: WorkflowCreationOptions;
    $ID: string;
    $Type: "Workflows$Workflow";
    adminPage: null | PageReference;
    annotation: null | Workflows.Annotation;
    documentation: string;
    dueDate: null | string;
    excluded: boolean;
    exportLevel: ExportLevel;
    flow: Workflows.Flow;
    name: string;
    onWorkflowEvent: WorkflowEventHandler[];
    parameter: Parameter;
    persistentId: string;
    title: string;
    workflowDescription: StringTemplate;
    workflowMetaData: null | WorkflowMetaData;
    workflowName: StringTemplate;
    workflowV2: boolean;
    addWorkflowEventHandler(): Promise<WorkflowEventHandler>;
}

Hierarchy (View Summary)

Document
- Workflow

Properties

`Optional`$CreationOptions

$CreationOptions?: WorkflowCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Workflows$Workflow"

The type of the element.

adminPage

adminPage: null | PageReference

annotation

annotation: null | Workflows.Annotation

documentation

documentation: string

dueDate

dueDate: null | string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

flow

flow: Workflows.Flow

name

name: string

onWorkflowEvent

onWorkflowEvent: WorkflowEventHandler[]

parameter

parameter: Parameter

persistentId

persistentId: string

title

title: string

workflowDescription

workflowDescription: StringTemplate

workflowMetaData

workflowMetaData: null | WorkflowMetaData

workflowName

workflowName: StringTemplate

workflowV2

workflowV2: boolean

Methods

addWorkflowEventHandler

addWorkflowEventHandler(): Promise<WorkflowEventHandler>
Returns Promise<WorkflowEventHandler>