Class WorkflowItemId

The WorkflowItemId class is a data model representing an identifier for an item under moderation within the social platform.

Inheritance

System.Object

Identifier

WorkflowItemId

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 WorkflowItemId : Identifier

Constructors

WorkflowItemId(String)

Constructor

Declaration

public WorkflowItemId(string id)

Parameters

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

Properties

Empty

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

Declaration

public static WorkflowItemId Empty { get; }

Property Value

Type	Description
WorkflowItemId

Methods

Create()

Creates an empty WorkflowItemId.

Declaration

public static WorkflowItemId Create()

Returns

Type	Description
WorkflowItemId	Empty WorkflowItemId instance

Create(String)

Parses a workflow item ID from a string-based identifier.

Declaration

public static WorkflowItemId Create(string id)

Parameters

Type	Name	Description
System.String	id	Identifer for the workflow item

Returns

Type	Description
WorkflowItemId	Instance of WorkflowItemId 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 WorkflowItemId have the same value of the underlying comment identifier, else returns false.

Overrides

Identifier.Equals(Object)

GetHashCode()

Returns a hash code representative of this WorkflowItemId.

Declaration

public override int GetHashCode()

Returns

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

Overrides

Identifier.GetHashCode()

IsNullOrEmpty(WorkflowItemId)

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

Declaration

public static bool IsNullOrEmpty(WorkflowItemId id)

Parameters

Type	Name	Description
WorkflowItemId	id	Workflow identifier to evaluate

Returns

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

Operators

Equality(WorkflowItemId, WorkflowItemId)

Evaluates the equality of two WorkflowItemId instances.

Declaration

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

Parameters

Type	Name	Description
WorkflowItemId	a	The operand on the left side of the equality operator.
WorkflowItemId	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(WorkflowItemId, WorkflowItemId)

Evaluates two WorkflowItemId instances for inequality.

Declaration

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

Parameters

Type	Name	Description
WorkflowItemId	a	The operand on the left side of the inequality operator.
WorkflowItemId	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.