Class WorkflowStatuses

Index

Constructors

Methods

getStatus getStatuses

Constructors

constructor

new WorkflowStatuses(client: Client): Version3.WorkflowStatuses
Parameters
- client: Client
Returns Version3.WorkflowStatuses
- Defined in src/version3/workflowStatuses.ts:8

Methods

getStatus

getStatus<T = Version3Models.StatusDetails>(
parameters: string | Version3Parameters.GetStatus,
callback: Callback<T>,
): Promise<void>
Returns a status. The status must be associated with an active workflow to be returned.

If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.StatusDetails
Parameters
- parameters: string | Version3Parameters.GetStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowStatuses.ts:45
getStatus<T = Version3Models.StatusDetails>(
parameters: string | Version3Parameters.GetStatus,
callback?: undefined,
): Promise<T>
Returns a status. The status must be associated with an active workflow to be returned.

If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.StatusDetails
Parameters
- parameters: string | Version3Parameters.GetStatus
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowStatuses.ts:59

getStatuses

getStatuses<T = Version3Models.StatusDetails[]>(
callback: Callback<T>,
): Promise<void>
Returns a list of all statuses associated with active workflows.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.StatusDetails[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowStatuses.ts:17
getStatuses<T = Version3Models.StatusDetails[]>(
callback?: undefined,
): Promise<T>
Returns a list of all statuses associated with active workflows.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.StatusDetails[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowStatuses.ts:25