Class Approval
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 instance base class.
Namespace: EPiServer.Approvals
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public abstract class Approval : Object, IReadOnly<Approval>, IReadOnlyConstructors
Approval()
Declaration
protected Approval()Properties
ActiveStepIndex
Index of the currently active step.
Declaration
public int ActiveStepIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ActiveStepStarted
DateTime when the currently active step was started.
Declaration
public DateTime ActiveStepStarted { get; set; }Property Value
| Type | Description |
|---|---|
| System.DateTime |
Completed
The time when the approval instance was completed.
Declaration
public Nullable<DateTime> Completed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
CompletedBy
The user that completed the approval instance.
Declaration
public string CompletedBy { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CompletedComment
The comment for the decision that completed the approval instance.
Declaration
public string CompletedComment { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DefinitionVersionID
The identifier for the version of the approval definition.
Declaration
public int DefinitionVersionID { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ID
The identifier of the approval instance.
Declaration
public int ID { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsReadOnly
Gets a value indicating whether this approval instance is read only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Reference
Reference to an approval. Override in inherited class.
Declaration
public abstract Uri Reference { get; }Property Value
| Type | Description |
|---|---|
| System.Uri |
RequireCommentOnApprove
Flag that specifies if the definition requires that an approve must be commented.
Declaration
public bool RequireCommentOnApprove { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
RequireCommentOnReject
Flag that specifies if the definition requires that a reject must be commented.
Declaration
public bool RequireCommentOnReject { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
RequireCommentOnStart
Flag that specifies if the definition requires that a start must be commented.
Declaration
public bool RequireCommentOnStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Started
The time when the approval instance was started.
Declaration
public DateTime Started { get; set; }Property Value
| Type | Description |
|---|---|
| System.DateTime |
StartedBy
The user that started the approval instance.
Declaration
public string StartedBy { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Status
Current status of the approval instance.
Declaration
public ApprovalStatus Status { get; set; }Property Value
| Type | Description |
|---|---|
| ApprovalStatus |
StepCount
The numbers of steps for the approval instance.
Declaration
public int StepCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
CreateWritableClone()
Creates a writable copy of the current object.
Declaration
public virtual Approval CreateWritableClone()Returns
| Type | Description |
|---|---|
| Approval | 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.
