Skip to main content

CompleteBranchRequest

Represents a request to complete a branch by creating a new version in the document management system.

This class extends BaseDocumentManagementRequest to handle branch completion operations. It manages security through encrypted/decrypted keys for both the object and branch, while also handling version numbering and settings. The class implements secure versioning patterns that ensure proper access verification and version control when converting a branch into a formal version.

Properties

NameDescription
SecretKeyGets the encrypted secret key for the object being versioned.
BranchSecretKeyGets the encrypted secret key for the branch being completed.
DecryptedBranchSecretGets the decrypted secret information for the branch being completed.
SetAsDefaultVersionGets whether the new version should be set as the default version of the object.
DecryptedObjectSecretGets the decrypted secret information for the object being versioned.
MinorVersionValueGets the minor version number for the new version being created from the branch.
CreatedByGets the ID of the user completing the branch.
MajorVersionValueGets the major version number for the new version being created from the branch.
VersionDateGets the optional timestamp to be assigned to the new version.

Constructors

NameDescription
CompleteBranchRequest()Initializes a new instance of the CompleteBranchRequest class.
CompleteBranchRequest(secretKey, branchSecretKey, majorVersionValue, minorVersionValue, versionDate, setAsDefaultVersion)Initializes a new instance of the CompleteBranchRequest class with security and version information.
CompleteBranchRequest()Initializes a new instance of the CompleteBranchRequest class.
CompleteBranchRequest(secretKey, branchSecretKey, majorVersionValue, minorVersionValue, versionDate, setAsDefaultVersion, createdBy)Initializes a new instance of the CompleteBranchRequest class with complete information.