Documentation

StringTranslationApi extends AbstractApi
in package

Use API to add or remove strings translations, approvals, and votes.

Table of Contents

Methods

create()  : StringTranslation|null
Add Translation
createApproval()  : StringTranslationApproval|null
Add Approval
createVote()  : Vote|null
Add Vote
delete()  : mixed
Delete Translation
deleteApproval()  : mixed
Remove Approval
deleteStringTranslations()  : mixed
Delete String Translations
deleteVote()  : mixed
Cancel Vote
get()  : StringTranslation|null
Get Translation
getApproval()  : StringTranslationApproval|null
Approval Info
getVote()  : Vote|null
Get Vote
list()  : ModelCollection
List String Translations
listApprovals()  : ModelCollection
List Translation Approvals
listLanguageTranslations()  : ModelCollection
List Language Translations
listVotes()  : ModelCollection
List Translation Votes
restore()  : StringTranslation|null
Restore Translation

Methods

listApprovals()

List Translation Approvals

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

integer $params[fileId] Must be used together with languageId
string $params[labelIds]
string $params[excludeLabelIds]
integer $params[stringId] Must be used together with languageId
string $params[languageId] Must be used together with stringId or fileId
integer $params[translationId] If specified, fileId, stringId and languageId are ignored
integer $params[limit]
integer $params[offset]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

listLanguageTranslations()

List Language Translations

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

string $params[orderBy]
string $params[stringIds]
string $params[labelIds]
int $params[fileId]
int $params[branchId]
int $params[directoryId]
int $params[approvedOnly]
string $params[croql]
int $params[denormalizePlaceholders]
int $params[limit]
int $params[offset]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

listVotes()

List Translation Votes

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

integer $params[stringId] Must be used together with languageId
string $params[languageId] Must be used together with stringId
integer $params[translationId] If specified, stringId and languageId are ignored
string $params[labelIds]
string $params[excludeLabelIds]
integer $params[limit]
integer $params[offset]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

        
On this page

Search results