com.crowdin.client.screenshots

Class ScreenshotsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.screenshots.ScreenshotsApi

public class ScreenshotsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Screenshot>	addScreenshot(java.lang.Long projectId, AddScreenshotRequest request)
ResponseObject<java.util.List<Tag>>	addTag(java.lang.Long projectId, java.lang.Long screenshotId, java.util.List<AddTagRequest> request)
void	clearTags(java.lang.Long projectId, java.lang.Long screenshotId)
void	deleteScreenshot(java.lang.Long projectId, java.lang.Long screenshotId)
void	deleteTag(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Long tagId)
ResponseObject<Screenshot>	editScreenshot(java.lang.Long projectId, java.lang.Long screenshotId, java.util.List<PatchRequest> request)
ResponseObject<Tag>	editTag(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Long tagId, java.util.List<PatchRequest> request)
ResponseObject<Screenshot>	getScreenshot(java.lang.Long projectId, java.lang.Long screenshotId)
ResponseObject<Tag>	getTag(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Long tagId)
ResponseList<Screenshot>	listScreenshots(java.lang.Long projectId, java.util.List<java.lang.String> stringIds, java.util.List<java.lang.String> labelIds, java.util.List<java.lang.String> excludeLabelIds, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Screenshot>	listScreenshots(java.lang.Long projectId, java.util.List<java.lang.String> stringIds, java.util.List<java.lang.String> labelIds, java.util.List<java.lang.String> excludeLabelIds, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Screenshot>	listScreenshots(java.lang.Long projectId, ListScreenshotsParams params)
ResponseList<Screenshot>	listScreenshots(java.lang.Long projectId, java.lang.Long stringId, java.lang.Integer limit, java.lang.Integer offset) Deprecated.
ResponseList<Tag>	listTags(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Integer limit, java.lang.Integer offset)
void	replaceTags(java.lang.Long projectId, java.lang.Long screenshotId, ReplaceTagsRequest request)
ResponseObject<Screenshot>	updateScreenshot(java.lang.Long projectId, java.lang.Long screenshotId, UpdateScreenshotRequest request)

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

ScreenshotsApi

public ScreenshotsApi(Credentials credentials)

ScreenshotsApi

public ScreenshotsApi(Credentials credentials,
                      ClientConfig clientConfig)

Method Detail

listScreenshots

@Deprecated
public ResponseList<Screenshot> listScreenshots(java.lang.Long projectId,
                                                            java.lang.Long stringId,
                                                            java.lang.Integer limit,
                                                            java.lang.Integer offset)
                                                     throws HttpException,
                                                            HttpBadRequestException

Deprecated.

Parameters:

projectId - project identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listScreenshots

public ResponseList<Screenshot> listScreenshots(java.lang.Long projectId,
                                                java.util.List<java.lang.String> stringIds,
                                                java.util.List<java.lang.String> labelIds,
                                                java.util.List<java.lang.String> excludeLabelIds,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

stringIds - string identifiers

labelIds - label identifiers

excludeLabelIds - exclude label identifiers

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listScreenshots

public ResponseList<Screenshot> listScreenshots(java.lang.Long projectId,
                                                java.util.List<java.lang.String> stringIds,
                                                java.util.List<java.lang.String> labelIds,
                                                java.util.List<java.lang.String> excludeLabelIds,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset,
                                                java.util.List<OrderByField> orderBy)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

stringIds - string identifiers

labelIds - label identifiers

excludeLabelIds - exclude label identifiers

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listScreenshots

public ResponseList<Screenshot> listScreenshots(java.lang.Long projectId,
                                                ListScreenshotsParams params)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

params - query params

Returns:

list of screenshots

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addScreenshot

public ResponseObject<Screenshot> addScreenshot(java.lang.Long projectId,
                                                AddScreenshotRequest request)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created screenshot

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getScreenshot

public ResponseObject<Screenshot> getScreenshot(java.lang.Long projectId,
                                                java.lang.Long screenshotId)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

Returns:

screenshot

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

updateScreenshot

public ResponseObject<Screenshot> updateScreenshot(java.lang.Long projectId,
                                                   java.lang.Long screenshotId,
                                                   UpdateScreenshotRequest request)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

request - request object

Returns:

updated screenshot

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteScreenshot

public void deleteScreenshot(java.lang.Long projectId,
                             java.lang.Long screenshotId)
                      throws HttpException,
                             HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editScreenshot

public ResponseObject<Screenshot> editScreenshot(java.lang.Long projectId,
                                                 java.lang.Long screenshotId,
                                                 java.util.List<PatchRequest> request)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

request - request object

Returns:

updated screenshot

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTags

public ResponseList<Tag> listTags(java.lang.Long projectId,
                                  java.lang.Long screenshotId,
                                  java.lang.Integer limit,
                                  java.lang.Integer offset)
                           throws HttpException,
                                  HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of tags

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

replaceTags

public void replaceTags(java.lang.Long projectId,
                        java.lang.Long screenshotId,
                        ReplaceTagsRequest request)
                 throws HttpException,
                        HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

request - request object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addTag

public ResponseObject<java.util.List<Tag>> addTag(java.lang.Long projectId,
                                                  java.lang.Long screenshotId,
                                                  java.util.List<AddTagRequest> request)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

request - request object

Returns:

newly created tags

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

clearTags

public void clearTags(java.lang.Long projectId,
                      java.lang.Long screenshotId)
               throws HttpException,
                      HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTag

public ResponseObject<Tag> getTag(java.lang.Long projectId,
                                  java.lang.Long screenshotId,
                                  java.lang.Long tagId)
                           throws HttpException,
                                  HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

tagId - tag identifier

Returns:

tag

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTag

public void deleteTag(java.lang.Long projectId,
                      java.lang.Long screenshotId,
                      java.lang.Long tagId)
               throws HttpException,
                      HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

tagId - tag identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTag

public ResponseObject<Tag> editTag(java.lang.Long projectId,
                                   java.lang.Long screenshotId,
                                   java.lang.Long tagId,
                                   java.util.List<PatchRequest> request)
                            throws HttpException,
                                   HttpBadRequestException

Parameters:

projectId - project identifier

screenshotId - screenshot identifier

tagId - tag identifier

request - request object

Returns:

updated screenshot

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation