Documentation

FileApi extends FileApi
in package

Use API to keep the source files up to date, check on file revisions

Table of Contents

Methods

buildReviewedSourceFiles()  : ReviewedSourceFileBuild
Build Reviewed Source Files
checkReviewedSourceFilesBuildStatus()  : ReviewedSourceFileBuild
Check Reviewed Source Files Build Status
create()  : File
Add File
delete()  : mixed
Delete File
download()  : DownloadFile|null
Download File
downloadPreview()  : DownloadFilePreview|null
Download Preview File
downloadReviewedSourceFiles()  : DownloadFile
edit()  : File|null
Edit File
get()  : File|null
Get File Info
getRevision()  : FileRevision|null
Get File Revision
list()  : ModelCollection
List Files
listReviewedSourceFilesBuilds()  : ModelCollection
List Reviewed Source Files Builds
restore()  : File
Restore file to revision
revisions()  : ModelCollection
List File Revisions
update()  : File
Update File

Methods

create()

Add File

public create(int $projectId, array<string|int, mixed> $data) : File
Parameters
$projectId : int
$data : array<string|int, mixed>

integer $data[storageId] required
string $data[name] required
integer $data[branchId] Can't be used with directoryId in same request
integer $data[directoryId] Can't be used with branchId in same request
string $data[title]
string $data[context]
string $data[type]
array $data[importOptions]
array $data[exportOptions]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
File

downloadReviewedSourceFiles()

public downloadReviewedSourceFiles(int $projectId, int $buildId) : DownloadFile
Parameters
$projectId : int
$buildId : int
Return values
DownloadFile

list()

List Files

public list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
$projectId : int
$params : array<string|int, mixed> = []

integer $params[branchId] Can't be used with directoryId in the same request
integer $params[directoryId] Can't be used with branchId in the same request
mixed $params[recursion] Works only when directoryId or branchId parameter is specified
integer $params[limit]
integer $params[offset]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

listReviewedSourceFilesBuilds()

List Reviewed Source Files Builds

public listReviewedSourceFilesBuilds(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
$projectId : int
$params : array<string|int, mixed> = []

integer $params[branchId]
integer $params[limit]
integer $params[offset]

Tags
link

API Documentation Enterprise

Return values
ModelCollection

update()

Update File

public update(int $projectId, int $fileId, array<string|int, mixed> $data) : File
Parameters
$projectId : int
$fileId : int
$data : array<string|int, mixed>

array $data[storageId] required
array $data[updateOption]
array $data[importOptions]
array $data[exportOptions]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
File

        
On this page

Search results