Home Manual Reference Source

import Workflow from '@pageproof/sdk/src/models/Workflow.js'

public class | source

Workflow

Member Summary

Public Members
public	id: string The workflow's unique identifier.
public	name: string The workflow's name. By default workflows have a name of "* This workflow needs a name".
public	steps: Array<WorkflowStep>: * An unordered list of workflow steps in the workflow.

Method Summary

Public Methods
public	getApproverStep(): WorkflowStep Convenience method for returning the workflow's approver step.
public	getOrderedSteps(): Array<WorkflowStep> Returns a list of WorkflowSteps in the order they have been designed to flow.
public	getStepByPosition(position: number): WorkflowStep Returns a WorkflowStep by it's position within the workflow.

Public Members

public id: string source

The workflow's unique identifier.

public name: string source

The workflow's name. By default workflows have a name of "* This workflow needs a name".

public steps: Array<WorkflowStep>: * source

An unordered list of workflow steps in the workflow.

Return:

Array<WorkflowStep>

See:

Workflow#getOrderedSteps

Public Methods

public getApproverStep(): WorkflowStep source

Convenience method for returning the workflow's approver step.

Return:

See:

Workflow#getStepByPosition

public getOrderedSteps(): Array<WorkflowStep> source

Returns a list of WorkflowSteps in the order they have been designed to flow.

Return:

Array<WorkflowStep>

public getStepByPosition(position: number): WorkflowStep source

Returns a WorkflowStep by it's position within the workflow.

Params:

Name	Type	Attribute	Description
position	number		The workflow step position

Return: