Share via


SP.WorkflowServices.WorkflowSubscription object (sp.workflowservices)

Represents subscriptions for the external workflow host.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.WorkflowServices.WorkflowSubscription()

Members

The WorkflowSubscription object has the following members.

Constructor

The WorkflowSubscription object has the following constructor.

Constructor

Description

WorkflowSubscription

Initializes a new instance of the WorkflowSubscription object.

Methods

The WorkflowSubscription object has the following methods.

Method

Description

initPropertiesFromJson

newObject

setProperty

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

Properties

The WorkflowSubscription object has the following properties.

Property

Description

definitionId

Gets or sets the unique Id of the workflow definition to activate.

enabled

Gets or 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.

eventSourceId

Gets or sets the logical source instance name of the event.

eventTypes

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.

id

Gets or sets the unique identifier of the workflow subscription for the specified event source.

manualStartBypassesActivationLimit

A 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.

name

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

propertyDefinitions

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

statusFieldName

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