DirectoryApi
extends AbstractApi
in package
Manage project directories to keep files structure
Table of Contents
Methods
- checkDeleteStatus() : DeleteJob|null
- Check Delete Directory Job Status
- create() : Directory|null
- Add Directory
- delete() : mixed
- Delete Directory
- get() : Directory|null
- Get Directory Info
- list() : ModelCollection
- List Directories
- search() : ModelCollection
- Search Directories
- update() : Directory|null
- Edit Directory
Methods
checkDeleteStatus()
Check Delete Directory Job Status
public
checkDeleteStatus(int $projectId, int $directoryId, string $jobIdentifier) : DeleteJob|null
Parameters
- $projectId : int
- $directoryId : int
- $jobIdentifier : string
Tags
Return values
DeleteJob|nullcreate()
Add Directory
public
create(int $projectId, array<string|int, mixed> $data) : Directory|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name] required
integer $data[branchId]
integer $data[directoryId]
string $data[title]
string $data[exportPattern]
string $data[priority] Enum: "low" "normal" "high"
Tags
Return values
Directory|nulldelete()
Delete Directory
public
delete(int $projectId, int $directoryId[, string|null $prefer = null ]) : mixed
Parameters
- $projectId : int
- $directoryId : int
- $prefer : string|null = null
Tags
get()
Get Directory Info
public
get(int $projectId, int $directoryId) : Directory|null
Parameters
- $projectId : int
- $directoryId : int
Tags
Return values
Directory|nulllist()
List Directories
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[branchId]
integer $params[directoryId]
integer $params[recursion]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionsearch()
Search Directories
public
search([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
string $params[filter] required, max 128 characters
string $params[projectIds] Comma-separated project identifiers, max 50 projects
integer $params[userId] Crowdin API only
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Directory
public
update(Directory $directory) : Directory|null
Parameters
- $directory : Directory