LabelApi
extends AbstractApi
in package
Use labels in your project for an easy way to add context to the strings or organize them by certain topics.
Table of Contents
Methods
- assignScreenshots() : ModelCollection
- Assign Label to Screenshots
- create() : Label|null
- Add Label
- delete() : mixed
- Delete Label
- get() : Label|null
- Get Label Info
- list() : ModelCollection
- List Labels
- unassignScreenshots() : ModelCollection
- Unassign Label from Screenshots
- update() : Label|null
- Edit Label
Methods
assignScreenshots()
Assign Label to Screenshots
public
assignScreenshots(int $projectId, int $labelId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $projectId : int
- $labelId : int
- $data : array<string|int, mixed>
-
string[] $data[screenshotIds] required
Tags
Return values
ModelCollectioncreate()
Add Label
public
create(int $projectId, array<string|int, mixed> $data) : Label|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[title] required
Tags
Return values
Label|nulldelete()
Delete Label
public
delete(int $projectId, int $labelId) : mixed
Parameters
- $projectId : int
- $labelId : int
Tags
get()
Get Label Info
public
get(int $projectId, int $labelId) : Label|null
Parameters
- $projectId : int
- $labelId : int
Tags
Return values
Label|nulllist()
List Labels
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
ModelCollectionunassignScreenshots()
Unassign Label from Screenshots
public
unassignScreenshots(int $projectId, int $labelId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $projectId : int
- $labelId : int
- $data : array<string|int, mixed>
-
string[] $data[screenshotIds] required
Tags
Return values
ModelCollectionupdate()
Edit Label
public
update(Label $label) : Label|null
Parameters
- $label : Label