Class ApprovalStepDecision
NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. A decision by a user for a step in an approval instance.
Inheritance
Namespace: EPiServer.Approvals
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public class ApprovalStepDecision : Object, IReadOnly<ApprovalStepDecision>, IReadOnly
Constructors
ApprovalStepDecision()
Creates an empty ApprovalStepDecision/>.
Declaration
public ApprovalStepDecision()
Properties
Approved
User has approved(true) or rejected(false).
Declaration
public bool Approved { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Comment
An optional decision comment.
Declaration
public string Comment { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Decided
Timestamp of the decision.
Declaration
public DateTime Decided { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
IsReadOnly
Gets a value indicating whether this instance is read only.
Declaration
public bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Scope
Scope of the decision.
Declaration
public ApprovalDecisionScope Scope { get; set; }
Property Value
Type | Description |
---|---|
ApprovalDecisionScope |
StepIndex
Index of the step that this decision is connected to.
Declaration
public int StepIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Username
Name of the user.
Declaration
public string Username { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
CreateWritableClone()
Creates a writable copy of the current object.
Declaration
public ApprovalStepDecision CreateWritableClone()
Returns
Type | Description |
---|---|
ApprovalStepDecision | 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.