BranchApi
extends AbstractApi
in package
Manage project branches
Note: If you use branches, make sure your master branch is the first one you integrate with Crowdin.
Table of Contents
Methods
- checkCloneStatus() : BranchClone|null
- Check Branch Clone Status
- checkMergeStatus() : BranchMerge|null
- Check Branch Merge Status
- cloneBranch() : BranchClone|null
- Clone Branch
- create() : Branch|null
- Add Branch
- delete() : mixed
- Delete Branch
- get() : Branch|null
- Get Branch Info
- getClonedBranch() : Branch|null
- Get Cloned Branch
- getMergeSummary() : BranchMergeSummary|null
- Get Branch Merge Summary
- list() : ModelCollection
- List Branches
- mergeBranch() : BranchMerge|null
- Merge Branch
- update() : Branch|null
- Edit Branch
Methods
checkCloneStatus()
Check Branch Clone Status
public
checkCloneStatus(int $projectId, int $branchId, string $cloneId) : BranchClone|null
Parameters
- $projectId : int
- $branchId : int
- $cloneId : string
Tags
Return values
BranchClone|nullcheckMergeStatus()
Check Branch Merge Status
public
checkMergeStatus(int $projectId, int $branchId, string $mergeId) : BranchMerge|null
Parameters
- $projectId : int
- $branchId : int
- $mergeId : string
Tags
Return values
BranchMerge|nullcloneBranch()
Clone Branch
public
cloneBranch(int $projectId, int $branchId, array<string|int, mixed> $data) : BranchClone|null
Parameters
- $projectId : int
- $branchId : int
- $data : array<string|int, mixed>
-
string $data[name] required Note: Can't contain \ / : * ? " < > | symbols
string $data[title]
bool $data[isProtected]
Tags
Return values
BranchClone|nullcreate()
Add Branch
public
create(int $projectId, array<string|int, mixed> $data) : Branch|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name] required Note: Can't contain \ / : * ? " < > | symbols
string $data[title]
string $data[exportPattern] Note: Can't contain \ / : * ? " < > | symbols
string $data[priority] Enum: "low" "normal" "high"
bool $data[isProtected] String-based projects only
Tags
Return values
Branch|nulldelete()
Delete Branch
public
delete(int $projectId, int $branchId) : mixed
Parameters
- $projectId : int
- $branchId : int
Tags
get()
Get Branch Info
public
get(int $projectId, int $branchId) : Branch|null
Parameters
- $projectId : int
- $branchId : int
Tags
Return values
Branch|nullgetClonedBranch()
Get Cloned Branch
public
getClonedBranch(int $projectId, int $branchId, string $cloneId) : Branch|null
Parameters
- $projectId : int
- $branchId : int
- $cloneId : string
Tags
Return values
Branch|nullgetMergeSummary()
Get Branch Merge Summary
public
getMergeSummary(int $projectId, int $branchId, string $mergeId) : BranchMergeSummary|null
Parameters
- $projectId : int
- $branchId : int
- $mergeId : string
Tags
Return values
BranchMergeSummary|nulllist()
List Branches
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
string $params[name]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionmergeBranch()
Merge Branch
public
mergeBranch(int $projectId, int $branchId, array<string|int, mixed> $data) : BranchMerge|null
Parameters
- $projectId : int
- $branchId : int
- $data : array<string|int, mixed>
-
int $data[sourceBranchId] required
bool $data[deleteAfterMerge]
bool $data[dryRun]
bool $data[acceptSourceChanges]
Tags
Return values
BranchMerge|nullupdate()
Edit Branch
public
update(Branch $branch) : Branch|null
Parameters
- $branch : Branch