Class WorkflowInstance

Represents an instance of a workflow association that performs on a list item the process that is defined in a workflow template

Hierarchy

Index

Methods

Methods

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public fromJson(initValue: any)

Parameters

  • initValue: any

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_faultInfo(): string

Contains the error string or exception information if the workflow faults.

Returns

string

public get_id(): string

Unique identifier (GUID) for the workflow instance

Returns

string

public get_instanceCreated(): string

Gets the Coordinated Universal Time (UTC) when this workflow instance was created.

Returns

string

public get_lastUpdated(): string

Gets the Coordinated Universal Time (UTC) when the workflow instance state was last persisted

Returns

string

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_properties(): { [name: string]: string; }

Specifies properties of this workflow instance

Returns

{ [name: string]: string; }

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_status(): WorkflowStatus

Returns runtime status of the workflow instance

Returns

WorkflowStatus

public get_typedObject(): ClientObject

Returns

ClientObject

public get_userStatus(): string

Specifies the custom status set by workflow authors.

Returns

string

public get_workflowSubscriptionId(): string

Gets the unique identifier (GUID) of the subscription that instantiates the WorkflowInstance

Returns

string

public initPropertiesFromJson(parentNode: any)

This method is internal and is not intended to be used in your code.

Parameters

  • parentNode: any

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_objectVersion(value: string)

Parameters

  • value: string

public set_userStatus(value: string): string

Specifies the custom status set by workflow authors.

Parameters

  • value: string

Returns

string