Class WorkflowSubscription

public get_definitionId(): any

Gets the unique ID of the workflow definition to activate.

Returns

any

public get_enabled(): boolean

Gets a boolean value that specifies if the workflow subscription is enabled. When disabled, new instances of the subscription cannot be started, but existing instances will continue to run.

Returns

boolean

public get_eventSourceId(): string

Gets the logical source instance name of the event. (GUID)

Returns

string

public get_eventTypes(): Array<string>

Gets or sets the list of event types for which the subscription is listening. For SharePoint events, these will map to a value in the SPEventReceiverType enumeration.

Returns

Array<string>

public get_id(): string

Unique identifier (GUID) of the workflow subscription

Returns

string

public get_manualStartBypassesActivationLimit(): boolean

Boolean value that specifies whether multiple workflow instances can be started manually on the same list item at the same time. This property can be used for list workflows only.

Returns

boolean

public get_name(): any

Gets the name of the workflow subscription for the specified event source.

Returns

any

public get_propertyDefinitions(): any

Gets the properties and values to pass to the workflow definition when the subscription is matched.

Returns

any

public get_statusFieldName(): string

Gets the name of the workflow status field on the specified list.

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)

Sets the name-value pairs for workflow definition initiation parameters that are stored in the PropertyDefinitions property

Parameters

• propertyName: string

• value: string

public set_definitionId(value: any): any

Sets the unique ID of the workflow definition to activate.

Parameters

• value: any

Returns

any

public set_enabled(value: boolean): boolean

Sets a boolean value that enables or disables the workflow subscription. When disabled, new instances of the subscription cannot be started, but existing instances will continue to run.

Parameters

• value: boolean

Returns

boolean

public set_eventSourceId(value: string): string

Sets the logical source instance name of the event. (GUID)

Parameters

• value: string

Returns

string

public set_eventTypes(value: Array<string>): Array<string>

Gets or sets the list of event types for which the subscription is listening. For SharePoint events, these will map to a value in the SPEventReceiverType enumeration.

Parameters

• value: Array<string>

Returns

Array<string>

public set_id(value: string): string

Unique identifier (GUID) of the workflow subscription

Parameters

• value: string

Returns

string

public set_manualStartBypassesActivationLimit(value: boolean): boolean

Boolean value that specifies whether multiple workflow instances can be started manually on the same list item at the same time. This property can be used for list workflows only.

Parameters

• value: boolean

Returns

boolean

public set_name(value: any): any

Sets the name of the workflow subscription for the specified event source.

Parameters

• value: any

Returns

any

public set_statusFieldName(value: string): string

Gets or sets the name of the workflow status field on the specified list.

Parameters

• value: string

Returns

string