public class ScreenshotsApi extends CrowdinApi
clientConfig, graphqlUrl, httpClient, url| Constructor and Description |
|---|
ScreenshotsApi(Credentials credentials) |
ScreenshotsApi(Credentials credentials,
ClientConfig clientConfig) |
| 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)
Replace tags using the "Auto Tag" form (
AutoTagReplaceTagsRequest). |
void |
replaceTagsWithList(java.lang.Long projectId,
java.lang.Long screenshotId,
java.util.List<AddTagRequest> request)
Replace tags with the given list of tags ("Replace Tags" form, sent as a JSON array)
|
ResponseObject<Screenshot> |
updateScreenshot(java.lang.Long projectId,
java.lang.Long screenshotId,
UpdateScreenshotRequest request) |
graphql, graphqlpublic ScreenshotsApi(Credentials credentials)
public ScreenshotsApi(Credentials credentials, ClientConfig clientConfig)
@Deprecated public ResponseList<Screenshot> listScreenshots(java.lang.Long projectId, java.lang.Long stringId, java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
projectId - project identifierlimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)HttpExceptionHttpBadRequestExceptionpublic 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
projectId - project identifierstringIds - string identifierslabelIds - label identifiersexcludeLabelIds - exclude label identifierslimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)HttpExceptionHttpBadRequestExceptionpublic 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
projectId - project identifierstringIds - string identifierslabelIds - label identifiersexcludeLabelIds - exclude label identifierslimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)orderBy - list of OrderByFieldHttpExceptionHttpBadRequestExceptionpublic ResponseList<Screenshot> listScreenshots(java.lang.Long projectId, ListScreenshotsParams params) throws HttpException, HttpBadRequestException
projectId - project identifierparams - query paramsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Screenshot> addScreenshot(java.lang.Long projectId, AddScreenshotRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Screenshot> getScreenshot(java.lang.Long projectId, java.lang.Long screenshotId) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Screenshot> updateScreenshot(java.lang.Long projectId, java.lang.Long screenshotId, UpdateScreenshotRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic void deleteScreenshot(java.lang.Long projectId,
java.lang.Long screenshotId)
throws HttpException,
HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Screenshot> editScreenshot(java.lang.Long projectId, java.lang.Long screenshotId, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseList<Tag> listTags(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierlimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)HttpExceptionHttpBadRequestExceptionpublic void replaceTags(java.lang.Long projectId,
java.lang.Long screenshotId,
ReplaceTagsRequest request)
throws HttpException,
HttpBadRequestException
AutoTagReplaceTagsRequest).
To replace tags with an explicit list of tags use replaceTagsWithList(Long, Long, List).projectId - project identifierscreenshotId - screenshot identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic void replaceTagsWithList(java.lang.Long projectId,
java.lang.Long screenshotId,
java.util.List<AddTagRequest> request)
throws HttpException,
HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierrequest - list of tagsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.List<Tag>> addTag(java.lang.Long projectId, java.lang.Long screenshotId, java.util.List<AddTagRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic void clearTags(java.lang.Long projectId,
java.lang.Long screenshotId)
throws HttpException,
HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Tag> getTag(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Long tagId) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifiertagId - tag identifierHttpExceptionHttpBadRequestExceptionpublic void deleteTag(java.lang.Long projectId,
java.lang.Long screenshotId,
java.lang.Long tagId)
throws HttpException,
HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifiertagId - tag identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<Tag> editTag(java.lang.Long projectId, java.lang.Long screenshotId, java.lang.Long tagId, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierscreenshotId - screenshot identifiertagId - tag identifierrequest - request objectHttpExceptionHttpBadRequestException