com.crowdin.client.dictionaries

Class DictionariesApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.dictionaries.DictionariesApi

public class DictionariesApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Dictionary>	editDictionary(java.lang.Long projectId, java.lang.String languageId, java.util.List<PatchRequest> request)
ResponseList<Dictionary>	listDictionaries(java.lang.Long projectId, java.lang.String languageIds)

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

DictionariesApi

public DictionariesApi(Credentials credentials)

DictionariesApi

public DictionariesApi(Credentials credentials,
                       ClientConfig clientConfig)
                throws HttpException,
                       HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

Method Detail

listDictionaries

public ResponseList<Dictionary> listDictionaries(java.lang.Long projectId,
                                                 java.lang.String languageIds)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

languageIds - language identifiers

Returns:

list of dictionaries

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editDictionary

public ResponseObject<Dictionary> editDictionary(java.lang.Long projectId,
                                                 java.lang.String languageId,
                                                 java.util.List<PatchRequest> request)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

languageId - language identifier

request - request object

Returns:

updated dictionary

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation