Class WorkflowSubscription

Defines a Workflow Subscription to provision

Inheritance
System.Object
BaseModel
WorkflowSubscription
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class WorkflowSubscription : BaseModel, IProvisioningTemplateDescendant

Constructors

WorkflowSubscription()

Default Constructor

Declaration
public WorkflowSubscription()

WorkflowSubscription(Dictionary<String, String>)

Constructor

Declaration
public WorkflowSubscription(Dictionary<String, String> propertyDefinitions)
Parameters
Dictionary<String, String> propertyDefinitions

Dictionary Key-Value pair of property definitions

Properties

DefinitionId

Defines the ID of the Workflow Definition for the current Subscription

Declaration
public Guid DefinitionId { get; set; }
Property Value
Guid

Enabled

Defines if the Workflow Definition is enabled for the current Subscription

Declaration
public Boolean Enabled { get; set; }
Property Value
Boolean

EventSourceId

Defines the ID of the Event Source for the current Subscription

Declaration
public String EventSourceId { get; set; }
Property Value
String

EventTypes

Defines the list of events that will start the workflow instance

Declaration
public List<String> EventTypes { get; set; }
Property Value
List<String>

Remarks

Possible values in the list: WorkflowStartEvent, ItemAddedEvent, ItemUpdatedEvent

ListId

Defines the ID of the target list/library for the current Subscription,

Declaration
public String ListId { get; set; }
Property Value
String

Remarks

Optional and if it is missing, the workflow subscription will be at Site level

ManualStartBypassesActivationLimit

Defines if the Workflow can be manually started bypassing the activation limit

Declaration
public Boolean ManualStartBypassesActivationLimit { get; set; }
Property Value
Boolean

Name

Defines the Name of the Workflow Subscription

Declaration
public String Name { get; set; }
Property Value
String

ParentContentTypeId

Defines the Parent ContentType Id of the Workflow Subscription

Declaration
public String ParentContentTypeId { get; set; }
Property Value
String

PropertyDefinitions

Defines the Property Definitions of the Workflows to provision

Declaration
public Dictionary<string, string> PropertyDefinitions { get; }
Property Value
Dictionary<System.String, System.String>

StatusFieldName

Defines the Status Field Name of the Workflow Subscription

Declaration
public String StatusFieldName { get; set; }
Property Value
String

Methods

Equals(WorkflowSubscription)

Comapres given workflow subscription object which is to be provisioned

Declaration
public bool Equals(WorkflowSubscription other)
Parameters
WorkflowSubscription other

WorkflowSubscription Object
Returns
System.Boolean

true if the WorkflowSubscription object is equal to the current object; otherwise, false.

Equals(Object)

Comapres given workflow subscription object which is to be provisioned

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

WorkflowSubscription Object
Returns
System.Boolean

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Gets hash code of workflow subscription

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns hash code in integer

Extension Methods