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
- create() : Branch|null
- Add Branch
- delete() : mixed
- Delete Branch
- get() : Branch|null
- Get Branch Info
- list() : ModelCollection
- List Branches
- update() : Branch|null
- Edit Branch
Methods
create()
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"
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|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
ModelCollectionupdate()
Edit Branch
public
update(Branch $branch) : Branch|null
Parameters
- $branch : Branch