Class WorkflowDefinition

public get_associationUrl(): string

Url of the association form

Returns

string

public get_description(): string

Returns

string

public get_displayName(): string

Returns

string

public get_draftVersion(): string

Identifier for a draft version of the workflow definition

Returns

string

public get_formField(): string

Defines the fields of the workflow initiation forms and association forms (CAML string)

Returns

string

public get_id(): string

Returns

string

public get_initiationUrl(): string

Returns

string

public get_properties(): { [propertyName: string]: any; }

Gets custom properties of the workflow definition

Returns

{ [propertyName: string]: any; }

public get_published(): boolean

true if the workflow definition has been published to the external workflow host; false if the workflow definition is only saved on the site

Returns

boolean

public get_requiresAssociationForm(): boolean

Determines whether to automatically generate an association form for this workflow. If the value is true, and the associationUrl is not already set, a default association form is automatically generated for the workflow when saveDefinition is called.

Returns

boolean

public get_requiresInitiationForm(): boolean

Determines whether to automatically generate an initiation form for this workflow. If the value is true, and the initiationUrl is not already set, a default initiation form is automatically generated for the workflow when saveDefinition is called.

Returns

boolean

public get_restrictScope(): string

RestrictToScope is a GUID value, used in conjunction with the RestrictToType property to further restrict the scope of the definition. For example, if the RestrictToType is "List", then setting the RestrictToScope to a particular list identifier limits the definition to be associable only to the specified list. If the RestrictToType is "List" but the RestrictToScope is null or the empty string, then the definition is associable to any list.

Returns

string

public get_restrictToType(): string

RestrictToType determines the possible event source type for a workflow subscription that uses this definition. Possible values include "List", "Site", the empty string, or null.

Returns

string

public get_xaml(): string

XAML definition of the workflow

Returns

string

public initPropertiesFromJson(parentNode: any)

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

Parameters

• parentNode: any

public setProperty(propertyName: string, value: string)

This method adds a key-value pair (propertyName, value) to the workflow definition object�s property bag.

Parameters

• propertyName: string

• value: string

public set_associationUrl(value: string): string

Url of the association form

Parameters

• value: string

Returns

string

public set_description(value: string): string

Parameters

• value: string

Returns

string

public set_displayName(value: string): string

Parameters

• value: string

Returns

string

public set_draftVersion(value: string): string

Identifier for a draft version of the workflow definition

Parameters

• value: string

Returns

string

public set_formField(value: string): string

Defines the fields of the workflow initiation forms and association forms (CAML string)

Parameters

• value: string

Returns

string

public set_id(value: string): string

Parameters

• value: string

Returns

string

public set_initiationUrl(value: string): string

Parameters

• value: string

Returns

string

public set_requiresAssociationForm(value: boolean): boolean

Determines whether to automatically generate an association form for this workflow. If the value is true, and the associationUrl is not already set, a default association form is automatically generated for the workflow when saveDefinition is called.

Parameters

• value: boolean

Returns

boolean

public set_requiresInitiationForm(value: boolean): boolean

Determines whether to automatically generate an initiation form for this workflow. If the value is true, and the initiationUrl is not already set, a default initiation form is automatically generated for the workflow when saveDefinition is called.

Parameters

• value: boolean

Returns

boolean

public set_restrictScope(value: string): string

RestrictToScope is a GUID value, used in conjunction with the RestrictToType property to further restrict the scope of the definition. For example, if the RestrictToType is "List", then setting the RestrictToScope to a particular list identifier limits the definition to be associable only to the specified list. If the RestrictToType is "List" but the RestrictToScope is null or the empty string, then the definition is associable to any list.

Parameters

• value: string

Returns

string

public set_restrictToType(value: string): string

RestrictToType determines the possible event source type for a workflow subscription that uses this definition. Possible values include "List", "Site", the empty string, or null.

Parameters

• value: string

Returns

string

public set_xaml(value: string): string

XAML definition of the workflow

Parameters

• value: string

Returns

string