Class ApprovalDefinitionStep
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 step in an approval definition.
Inheritance
Namespace: EPiServer.Approvals
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public class ApprovalDefinitionStep : Object, IReadOnly<ApprovalDefinitionStep>, IReadOnlyConstructors
ApprovalDefinitionStep()
Creates an empty ApprovalDefinition/>.
Declaration
public ApprovalDefinitionStep()ApprovalDefinitionStep(String, IEnumerable<ApprovalDefinitionReviewer>)
Creates a named ApprovalDefinitionStep object with a list of ApprovalDefinitionReviewer"/>.
Declaration
public ApprovalDefinitionStep(string name, IEnumerable<ApprovalDefinitionReviewer> reviewers)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Name of the step |
| System.Collections.Generic.IEnumerable<ApprovalDefinitionReviewer> | reviewers | Reviewers in this step |
Properties
IsReadOnly
Gets a value indicating whether this instance is read only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Name
Name of the step.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Reviewers
List of reviewers in this step.
Declaration
public IList<ApprovalDefinitionReviewer> Reviewers { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ApprovalDefinitionReviewer> |
SelfApprove
Flag that specifies if a reviewer can approve an approval created by the reviewer. If set, this flag overrides the corresponding definition flag.
Declaration
public Nullable<bool> SelfApprove { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Methods
CreateWritableClone()
Creates a writable copy of the current object.
Declaration
public ApprovalDefinitionStep CreateWritableClone()Returns
| Type | Description |
|---|---|
| ApprovalDefinitionStep | 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.
