Class AuditAndSnapshotSettings
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Contains information about the snapshot and audit settings that will be applied to an object update operation.
public class AuditAndSnapshotSettings- Inheritance
-
objectAuditAndSnapshotSettings
Properties
AuditSetting
The audit settings to use
public ChangeAuditSetting AuditSetting { get; }Property Value
CommentsOptional
Indicates whether the user should be prompted for optional comments
public bool CommentsOptional { get; }Property Value
- bool
CommentsRequired
Indicates whether the user is required to enter comments.
public bool CommentsRequired { get; }Property Value
- bool
PromptUser
Indicates whether the user should be prompted for input.
public bool PromptUser { get; }Property Value
- bool
Remarks
If PromptUser returns True, the user should be prompted for input as follows: The user may enter comments. If CommentsRequired is True, the user must enter comments and cannot cancel.
If SnapshotOptional is True, the user should be prompted to select whether a snapshot will
be created.
SnapshotOptional
Indicates whether the user is allowed to choose whether a snapshot will be created.
public bool SnapshotOptional { get; }Property Value
- bool
SnapshotSetting
The snapshot settings to use
public ChangeAuditSetting SnapshotSetting { get; }Property Value
WillCreateAudit
Indicates whether an Audit record will be created for the operation.
public bool WillCreateAudit { get; }Property Value
- bool
Remarks
If WillCreateAudit is True, an audit record will be created regardless of the user's selections in the prompt window.
WillCreateSnapshot
Indicates whether a Snapshot will be created for the operation.
public bool WillCreateSnapshot { get; }Property Value
- bool
Remarks
If SnapshotOptional is True, the snapshot will only be created if the user selects the option to create it.