com.crowdin.client.labels

Class LabelsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.labels.LabelsApi

public class LabelsApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
LabelsApi(Credentials credentials)
LabelsApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<Label>	addLabel(java.lang.Long projectId, AddLabelRequest request)
ResponseList<Screenshot>	assignLabelToScreenshots(java.lang.Long projectId, java.lang.Long labelId, LabelToScreenshotsRequest request)
ResponseList<SourceString>	assignLabelToStrings(java.lang.Long projectId, java.lang.Long labelId, LabelToStringsRequest request)
void	deleteLabel(java.lang.Long projectId, java.lang.Long labelId)
ResponseObject<Label>	editLabel(java.lang.Long projectId, java.lang.Long labelId, java.util.List<PatchRequest> request)
ResponseObject<Label>	getLabel(java.lang.Long projectId, java.lang.Long labelId)
ResponseList<Label>	listLabels(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset, BooleanInt isSystem)
ResponseList<Label>	listLabels(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset, BooleanInt isSystem, java.util.List<OrderByField> orderBy)
ResponseList<Screenshot>	unassignLabelFromScreenshots(java.lang.Long projectId, java.lang.Long labelId, java.util.List<java.lang.Long> screenshotIds)
ResponseList<SourceString>	unassignLabelFromStrings(java.lang.Long projectId, java.lang.Long labelId, java.util.List<java.lang.Long> stringIds)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelsApi

public LabelsApi(Credentials credentials)

LabelsApi

public LabelsApi(Credentials credentials,
                 ClientConfig clientConfig)

Method Detail

listLabels

public ResponseList<Label> listLabels(java.lang.Long projectId,
                                      java.lang.Integer limit,
                                      java.lang.Integer offset,
                                      BooleanInt isSystem)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

projectId - Project Identifier

limit - A maximum number of items to retrieve. Default: 25

offset - A starting offset in the collection. Default: 0

isSystem - Filter collection by isSystem value

Returns:

list of labels

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listLabels

public ResponseList<Label> listLabels(java.lang.Long projectId,
                                      java.lang.Integer limit,
                                      java.lang.Integer offset,
                                      BooleanInt isSystem,
                                      java.util.List<OrderByField> orderBy)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

projectId - Project Identifier

limit - A maximum number of items to retrieve. Default: 25

offset - A starting offset in the collection. Default: 0

isSystem - Filter collection by isSystem value

orderBy - list of OrderByField

Returns:

list of labels

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addLabel

public ResponseObject<Label> addLabel(java.lang.Long projectId,
                                      AddLabelRequest request)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

projectId - Project Identifier

request - Request object

Returns:

created label

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getLabel

public ResponseObject<Label> getLabel(java.lang.Long projectId,
                                      java.lang.Long labelId)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

Returns:

label

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteLabel

public void deleteLabel(java.lang.Long projectId,
                        java.lang.Long labelId)
                 throws HttpException,
                        HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editLabel

public ResponseObject<Label> editLabel(java.lang.Long projectId,
                                       java.lang.Long labelId,
                                       java.util.List<PatchRequest> request)
                                throws HttpException,
                                       HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

request - Request object

Returns:

edited label

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

assignLabelToStrings

public ResponseList<SourceString> assignLabelToStrings(java.lang.Long projectId,
                                                       java.lang.Long labelId,
                                                       LabelToStringsRequest request)
                                                throws HttpException,
                                                       HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

request - Request object

Returns:

Source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

unassignLabelFromStrings

public ResponseList<SourceString> unassignLabelFromStrings(java.lang.Long projectId,
                                                           java.lang.Long labelId,
                                                           java.util.List<java.lang.Long> stringIds)
                                                    throws HttpException,
                                                           HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

stringIds - List of string IDs

Returns:

Source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

assignLabelToScreenshots

public ResponseList<Screenshot> assignLabelToScreenshots(java.lang.Long projectId,
                                                         java.lang.Long labelId,
                                                         LabelToScreenshotsRequest request)
                                                  throws HttpException,
                                                         HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

request - Request Object

Returns:

Screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

unassignLabelFromScreenshots

public ResponseList<Screenshot> unassignLabelFromScreenshots(java.lang.Long projectId,
                                                             java.lang.Long labelId,
                                                             java.util.List<java.lang.Long> screenshotIds)
                                                      throws HttpException,
                                                             HttpBadRequestException

Parameters:

projectId - Project Identifier

labelId - Label Identifier

Returns:

Screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation