Class WorkflowId

The WorkflowId class is a data model representing an identifier for a moderation workflow within the social platform.

Inheritance

System.Object

Identifier

WorkflowId

Inherited Members

Identifier.ToString()

Identifier.ToReference()

Identifier.Id

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Social.Moderation.Core

Assembly: EPiServer.Social.Moderation.Core.dll

Version: 1.5.4

Syntax

public class WorkflowId : Identifier

Constructors

WorkflowId(String)

Constructor

Declaration

public WorkflowId(string id)

Parameters

Type	Name	Description
System.String	id	String-based identifier for a workflow

Properties

Empty

Returns a newly created WorkflowId instance representing an 'empty' workflow ID.

Declaration

public static WorkflowId Empty { get; }

Property Value

Type	Description
WorkflowId

Methods

Create()

Creates an empty WorkflowId.

Declaration

public static WorkflowId Create()

Returns

Type	Description
WorkflowId	Empty WorkflowId instance

Create(String)

Parses a workflow ID from a string-based identifier.

Declaration

public static WorkflowId Create(string id)

Parameters

Type	Name	Description
System.String	id	Identifer for the workflow

Returns

Type	Description
WorkflowId	Instance of WorkflowId representing the specified identifier

Equals(Object)

Compares this instance with another object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	the object to compare with this instance.

Returns

Type	Description
System.Boolean	Returns true if this instance and another specified object, of type WorkflowId have the same value of the underlying comment identifier, else returns false.

Overrides

Identifier.Equals(Object)

GetHashCode()

Returns a hash code representative of this WorkflowId.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A 32-bit signed integer hash code.

Overrides

Identifier.GetHashCode()

IsNullOrEmpty(WorkflowId)

Returns true if the specified WorkflowId has not been initialized or represents an empty workflow identifier, false otherwise.

Declaration

public static bool IsNullOrEmpty(WorkflowId id)

Parameters

Type	Name	Description
WorkflowId	id	Workflow identifier to evaluate

Returns

Type	Description
System.Boolean	True if the WorkflowId is null or empty, false otherwise

Operators

Equality(WorkflowId, WorkflowId)

Evaluates the equality of two WorkflowId instances.

Declaration

public static bool operator ==(WorkflowId a, WorkflowId b)

Parameters

Type	Name	Description
WorkflowId	a	The operand on the left side of the equality operator.
WorkflowId	b	The operand on the right side of the equality operator.

Returns

Type	Description
System.Boolean	Returns true if the specified instances are equivalent, false otherwise.

Inequality(WorkflowId, WorkflowId)

Evaluates two WorkflowId instances for inequality.

Declaration

public static bool operator !=(WorkflowId a, WorkflowId b)

Parameters

Type	Name	Description
WorkflowId	a	The operand on the left side of the inequality operator.
WorkflowId	b	The operand on the right side of the inequality operator.

Returns

Type	Description
System.Boolean	Returns true if the specified instances are not equivalent, false otherwise.