Skip to main content

CompleteBranchRequest Constructors

An object defining constructors for the CompleteBranchRequest class.

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.

Parameters:

secretKey (required): string
The encrypted secret key for the object being versioned.

branchSecretKey (required): string
The encrypted secret key for the branch being completed.

majorVersionValue (required): long
The major version number for the new version.

minorVersionValue (required): long
The minor version number for the new version.

versionDate (optional): DateTimeOffset?
The timestamp to be assigned to the new version.

setAsDefaultVersion (required): bool
Whether to set the new version as the default version.

This constructor creates a new CompleteBranchRequest instance with the provided security keys and version details. It uses the system's current user context for audit information.


CompleteBranchRequest()

Initializes a new instance of the CompleteBranchRequest class.

Provides a default constructor for creating instances of the CompleteBranchRequest class.


CompleteBranchRequest(secretKey, branchSecretKey, majorVersionValue, minorVersionValue, versionDate, setAsDefaultVersion, createdBy)

Initializes a new instance of the CompleteBranchRequest class with complete information.

Parameters:

secretKey (required): string
The encrypted secret key for the object being versioned.

branchSecretKey (required): string
The encrypted secret key for the branch being completed.

majorVersionValue (required): long
The major version number for the new version.

minorVersionValue (required): long
The minor version number for the new version.

versionDate (optional): DateTimeOffset?
The timestamp to be assigned to the new version.

setAsDefaultVersion (required): bool
Whether to set the new version as the default version.

createdBy (optional): long?
The ID of the user completing the branch.

This constructor, marked with the JsonConstructor attribute for JSON deserialization support, creates a new CompleteBranchRequest instance with complete information. It initializes both the security keys and version details along with optional audit information, allowing for full tracking of the branch completion process.