ScreenshotApi
extends AbstractApi
in package
Screenshots provide translators with additional context for the source strings.
Screenshot tags allow specifying which source strings are displayed on each screenshot. Use API to manage screenshots and their tags.
Table of Contents
Methods
- addTag() : Tag|null
- Add Tag
- clearTags() : mixed
- Clear Tags
- create() : Screenshot|null
- Add Screenshot
- delete() : mixed
- Delete Screenshot
- deleteTag() : mixed
- Delete Tag
- get() : Screenshot|null
- Get Screenshot
- getTag() : Tag|null
- Get Tag
- list() : ModelCollection
- List Screenshots
- replace() : Screenshot|null
- Update Screenshot
- replaceTags() : mixed
- Replace Tags
- tags() : ModelCollection
- List Tags
- update() : Screenshot|null
- Edit Screenshot
- updateTag() : mixed
- Edit Tag
Methods
addTag()
Add Tag
public
addTag(int $projectId, int $screenshotId, array<string|int, mixed> $data) : Tag|null
Parameters
- $projectId : int
- $screenshotId : int
- $data : array<string|int, mixed>
-
integer $data[stringId] required
array $data[position]
Tags
Return values
Tag|nullclearTags()
Clear Tags
public
clearTags(int $projectId, int $screenshotId) : mixed
Parameters
- $projectId : int
- $screenshotId : int
Tags
create()
Add Screenshot
public
create(int $projectId, array<string|int, mixed> $data) : Screenshot|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
integer $data[storageId] required
string $data[name] required
bool $data[autoTag] Automatically tags screenshot
Tags
Return values
Screenshot|nulldelete()
Delete Screenshot
public
delete(int $projectId, int $screenshotId) : mixed
Parameters
- $projectId : int
- $screenshotId : int
Tags
deleteTag()
Delete Tag
public
deleteTag(int $projectId, int $screenshotId, int $tagId) : mixed
Parameters
- $projectId : int
- $screenshotId : int
- $tagId : int
Tags
get()
Get Screenshot
public
get(int $projectId, int $screenshotId) : Screenshot|null
Parameters
- $projectId : int
- $screenshotId : int
Tags
Return values
Screenshot|nullgetTag()
Get Tag
public
getTag(int $projectId, int $screenshotId, int $tagId) : Tag|null
Parameters
- $projectId : int
- $screenshotId : int
- $tagId : int
Tags
Return values
Tag|nulllist()
List Screenshots
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionreplace()
Update Screenshot
public
replace(int $projectId, int $screenshotId, int $storageId, string $name) : Screenshot|null
Parameters
- $projectId : int
- $screenshotId : int
- $storageId : int
- $name : string
Tags
Return values
Screenshot|nullreplaceTags()
Replace Tags
public
replaceTags(int $projectId, int $screenshotId, array<string|int, mixed> $data) : mixed
Parameters
- $projectId : int
- $screenshotId : int
- $data : array<string|int, mixed>
Tags
tags()
List Tags
public
tags(int $projectId, int $screenshotId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $screenshotId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Screenshot
public
update(int $projectId, Screenshot $screenshot) : Screenshot|null
Parameters
- $projectId : int
- $screenshot : Screenshot
Tags
Return values
Screenshot|nullupdateTag()
Edit Tag
public
updateTag(int $projectId, Tag $tag) : mixed
Parameters
- $projectId : int
- $tag : Tag