Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkflowState

Class representing the WorkflowState resource.

It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have its status set to one of the workflow states defined within the hub.

In the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.

Hierarchy

Index

Constructors

constructor

Properties

Optional _links

_links: Map<string, HalLink>

color

color: string

Assigned colour in the format of rgb(R,G,B)

Optional createdBy

createdBy: string

Id of the user responsible for originally creating the Workflow State

Optional createdDate

createdDate: string

Timestamp representing when the Workflow State was originally created in ISO 8601 format

Optional id

id: string

Unique id generated on creation

Optional label

label: string

Friendly display label for the WorkflowState

Optional lastModifiedBy

lastModifiedBy: string

Id of the user responsible for the last update to the Workflow State

Optional lastModifiedDate

lastModifiedDate: string

Timestamp representing when the Workflow State was last updated in ISO 8601 format

Methods

Protected performActionWithoutResourceResponse

  • performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

toJSON

  • toJSON(): any

toJson

  • toJson(): any

Object literals

Readonly related

related: object

Resources and actions related to a WorkflowState

hub

  • hub(): Promise<Hub>

update

Generated using TypeDoc