com.crowdin.client.sourcestrings

Class SourceStringsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.sourcestrings.SourceStringsApi

public class SourceStringsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<SourceString>	addSourcePluralString(java.lang.Long projectId, AddSourcePluralStringRequest request)
ResponseObject<SourceString>	addSourcePluralStringStringsBased(java.lang.Long projectId, AddSourcePluralStringStringsBasedRequest request)
ResponseObject<SourceString>	addSourceString(java.lang.Long projectId, AddSourceStringRequest request)
ResponseObject<SourceString>	addSourceStringStringsBased(java.lang.Long projectId, AddSourceStringStringsBasedRequest request)
void	deleteSourceString(java.lang.Long projectId, java.lang.Long stringId)
ResponseObject<SourceString>	editSourceString(java.lang.Long projectId, java.lang.Long stringId, java.util.List<PatchRequest> request)
ResponseObject<SourceString>	getSourceString(java.lang.Long projectId, java.lang.Long stringId)
ResponseList<SourceString>	listSourceStrings(java.lang.Long projectId, ListSourceStringsParams params)
ResponseList<SourceString>	listSourceStrings(java.lang.Long projectId, java.lang.Long fileId, java.lang.Integer denormalizePlaceholders, java.lang.Long branchId, java.lang.String labelIds, java.lang.String croql, java.lang.String filter, java.lang.String scope, java.lang.Integer limit, java.lang.Integer offset) Deprecated.
ResponseList<SourceString>	stringBatchOperations(java.lang.Long projectId, java.util.List<PatchRequest> request)
ResponseObject<UploadStringsProgress>	uploadStrings(java.lang.Long projectId, UploadStringsRequest request)
ResponseObject<UploadStringsProgress>	uploadStringsStatus(java.lang.Long projectId, java.lang.String uploadId)

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

SourceStringsApi

public SourceStringsApi(Credentials credentials)

SourceStringsApi

public SourceStringsApi(Credentials credentials,
                        ClientConfig clientConfig)

Method Detail

uploadStringsStatus

public ResponseObject<UploadStringsProgress> uploadStringsStatus(java.lang.Long projectId,
                                                                 java.lang.String uploadId)
                                                          throws HttpException,
                                                                 HttpBadRequestException

Parameters:

projectId - project identifier

uploadId - upload identifier

Throws:

HttpException

HttpBadRequestException

uploadStrings

public ResponseObject<UploadStringsProgress> uploadStrings(java.lang.Long projectId,
                                                           UploadStringsRequest request)
                                                    throws HttpException,
                                                           HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

listSourceStrings

@Deprecated
public ResponseList<SourceString> listSourceStrings(java.lang.Long projectId,
                                                                java.lang.Long fileId,
                                                                java.lang.Integer denormalizePlaceholders,
                                                                java.lang.Long branchId,
                                                                java.lang.String labelIds,
                                                                java.lang.String croql,
                                                                java.lang.String filter,
                                                                java.lang.String scope,
                                                                java.lang.Integer limit,
                                                                java.lang.Integer offset)
                                                         throws HttpException,
                                                                HttpBadRequestException

Deprecated.

Parameters:

projectId - project identifier

fileId - file identifier

denormalizePlaceholders - [0, 1]. Enable denormalize placeholders

branchId - project identifier

labelIds - filter strings by labels

croql - filter strings by croql

filter - Filter strings

scope - ["identifier", "text", "context"]. Specify field to be the target of filtering. It can be one scope or a list of comma-separated scopes

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

offset - starting offset in the collection (default 0)

Returns:

list of source strings

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listSourceStrings

public ResponseList<SourceString> listSourceStrings(java.lang.Long projectId,
                                                    ListSourceStringsParams params)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

params - Query params

Returns:

list of source strings

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addSourceString

public ResponseObject<SourceString> addSourceString(java.lang.Long projectId,
                                                    AddSourceStringRequest request)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addSourcePluralString

public ResponseObject<SourceString> addSourcePluralString(java.lang.Long projectId,
                                                          AddSourcePluralStringRequest request)
                                                   throws HttpException,
                                                          HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addSourceStringStringsBased

public ResponseObject<SourceString> addSourceStringStringsBased(java.lang.Long projectId,
                                                                AddSourceStringStringsBasedRequest request)
                                                         throws HttpException,
                                                                HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addSourcePluralStringStringsBased

public ResponseObject<SourceString> addSourcePluralStringStringsBased(java.lang.Long projectId,
                                                                      AddSourcePluralStringStringsBasedRequest request)
                                                               throws HttpException,
                                                                      HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

getSourceString

public ResponseObject<SourceString> getSourceString(java.lang.Long projectId,
                                                    java.lang.Long stringId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

Returns:

source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteSourceString

public void deleteSourceString(java.lang.Long projectId,
                               java.lang.Long stringId)
                        throws HttpException,
                               HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editSourceString

public ResponseObject<SourceString> editSourceString(java.lang.Long projectId,
                                                     java.lang.Long stringId,
                                                     java.util.List<PatchRequest> request)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

request - request object

Returns:

updated source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

stringBatchOperations

public ResponseList<SourceString> stringBatchOperations(java.lang.Long projectId,
                                                        java.util.List<PatchRequest> request)
                                                 throws HttpException,
                                                        HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

updated source string

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation