SP.Workflow.WorkflowAssociation object (sp.js)

  • Article

Represents the association of a workflow template with a specific list or content type, and that contains members that return custom information about that workflow's association with the specific list or content type.

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

var object = new SP.Workflow.WorkflowAssociation()

Members

The WorkflowAssociation object has the following members.

Constructor

The WorkflowAssociation object has the following constructor.

Constructor

Description

WorkflowAssociation

Initializes a new instance of the SP.Workflow.WorkflowAssociation object (sp.js).

Methods

The WorkflowAssociation object has the following methods.

Method

Description

deleteObject

Removes this workflow association from its parent WorkflowAssociations collection.

initPropertiesFromJson

update

Informs this workflow association's parent WorkflowAssociation collection that changes have been made to this workflow association.

Properties

The WorkflowAssociation object has the following properties.

Property

Description

allowManual

Gets or sets a value that specifies whether workflow instances based on this workflow association can be started manually.

associationData

Gets or sets a value that specifies whether workflow instances based on this workflow association can be started manually.

autoStartChange

Gets or sets a value that specifies whether workflow instances based on this workflow association can be started manually.

autoStartCreate

Gets or sets a value that specifies whether workflow instances will be created from this workflow association and started automatically when a list item is changed.

baseId

Gets a value that specifies the identifier of the workflow template on which this workflow association is based.

created

Gets a value that specifies the date and time at which this workflow association was created.

description

Gets or sets a value that specifies the description for this workflow association.

enabled

Gets or sets a value that specifies whether new workflow instances will be allowed for this workflow association

historyListTitle

Gets or sets a value that specifies the title of the list to which to log workflow history events for this workflow association.

id

Gets a value that specifies the identifier of the workflow association.

instantiationUrl

Gets a value that specifies the URL of the workflow initiation form for this workflow association.

internalName

Gets a value that specifies the internal name of this workflow association, as determined by the WorkflowAssociation implementation.

isDeclarative

Gets a value that specifies whether the workflow association represents a declarative workflow.

listId

Gets a value that specifies the identifier of the list on which this workflow association resides.

modified

Gets a value that specifies the data and time at which this workflow association was last modified.

name

Gets or sets a value that specifies the name of this workflow association.

taskListTitle

Gets or sets a value that specifies the title of the list within which workflow tasks will be created for this workflow association.

webId

Gets a value that specifies the identifier of the site on which the workflow association resides.