Try our conversational search powered by Generative AI!

AI OnAI Off

Class ApprovalDefinition

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. An approval definition base class.

Inheritance
System.Object
ApprovalDefinition
ContentApprovalDefinition
FallbackApprovalDefinition
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Approvals
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
public abstract class ApprovalDefinition : IReadOnly<ApprovalDefinition>, IReadOnly

Constructors

ApprovalDefinition()

Declaration
protected ApprovalDefinition()

Properties

DemandCommentOnReject

Declaration
[Obsolete("Use RequireCommentOnReject")]
public bool DemandCommentOnReject { get; set; }
Property Value
Type Description
System.Boolean

ID

The identifier of the definition.

Declaration
public int ID { get; set; }
Property Value
Type Description
System.Int32

IsEnabled

Gets or sets whether the approval definition is enabled.

Declaration
public bool IsEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsReadOnly

Gets a value indicating whether this instance is read only.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
System.Boolean

true if this instance is read only; otherwise, false.

Reference

Reference to an approval definition. Override in inherited class.

Declaration
public abstract Uri Reference { get; }
Property Value
Type Description
System.Uri

RequireCommentOnApprove

Flag that specifies if an approve must be commented.

Declaration
public bool RequireCommentOnApprove { get; set; }
Property Value
Type Description
System.Boolean

RequireCommentOnReject

Flag that specifies if a reject must be commented.

Declaration
public bool RequireCommentOnReject { get; set; }
Property Value
Type Description
System.Boolean

RequireCommentOnStart

Flag that specifies if a start must be commented.

Declaration
public bool RequireCommentOnStart { get; set; }
Property Value
Type Description
System.Boolean

Saved

The time when the definition version was saved.

Declaration
public DateTime Saved { get; set; }
Property Value
Type Description
System.DateTime

SavedBy

The user that saved the definition version.

Declaration
public string SavedBy { get; set; }
Property Value
Type Description
System.String

SelfApprove

Flag that specifies if a reviewer can approve an approval created by the reviewer.

Declaration
public bool SelfApprove { get; set; }
Property Value
Type Description
System.Boolean

Steps

List of approval steps for this definition

Declaration
public IList<ApprovalDefinitionStep> Steps { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<ApprovalDefinitionStep>

VersionID

The identifier for the version of the definition.

Declaration
public int VersionID { get; set; }
Property Value
Type Description
System.Int32

Methods

CreateWritableClone()

Creates a writable copy of the current object.

Declaration
public virtual ApprovalDefinition CreateWritableClone()
Returns
Type Description
ApprovalDefinition

A writable copy of the current object.
Remarks

The cloning is a deep-copy.

MakeReadOnly()

Makes this instance read-only.

Declaration
public void MakeReadOnly()

ThrowIfReadOnly()

Throws an exception if the current instance is read-only.

Declaration
protected void ThrowIfReadOnly()

Explicit Interface Implementations

IReadOnly.CreateWritableClone()

Creates a writable copy of the current object.

Declaration
object IReadOnly.CreateWritableClone()
Returns
Type Description
System.Object

A writable copy of the current object.
Remarks

The cloning is a deep-copy.

Implements

Extension Methods