com.crowdin.client.fields

Class FieldsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.fields.FieldsApi

public class FieldsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Field>	addField(FieldRequest request)
void	deleteField(java.lang.Long fieldId)
ResponseObject<Field>	editField(java.lang.Long fieldId, java.util.List<PatchRequest> request)
ResponseList<Field>	getField(java.lang.Long fieldId)
ResponseList<Field>	listFields(ListFieldsParams params)
ResponseList<Field>	listFields(java.lang.String entity, java.lang.String search, java.lang.Integer limit, java.lang.Integer offset)

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

FieldsApi

public FieldsApi(Credentials credentials)

FieldsApi

public FieldsApi(Credentials credentials,
                 ClientConfig clientConfig)

Method Detail

listFields

public ResponseList<Field> listFields(java.lang.String entity,
                                      java.lang.String search,
                                      java.lang.Integer limit,
                                      java.lang.Integer offset)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

entity - Filter fields by entity EntityType

search - Search fields by slug or name

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

offset - starting offset in the collection (default 0)

Returns:

list of distributions

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation

listFields

public ResponseList<Field> listFields(ListFieldsParams params)
                               throws HttpException,
                                      HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addField

public ResponseObject<Field> addField(FieldRequest request)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

request - object FieldRequest

Returns:

Field object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation

getField

public ResponseList<Field> getField(java.lang.Long fieldId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

fieldId - field identifier

Returns:

field object according to id

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation

deleteField

public void deleteField(java.lang.Long fieldId)
                 throws HttpException,
                        HttpBadRequestException

Parameters:

fieldId - field identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation

editField

public ResponseObject<Field> editField(java.lang.Long fieldId,
                                       java.util.List<PatchRequest> request)
                                throws HttpException,
                                       HttpBadRequestException

Parameters:

fieldId - field identifier

request - object

Returns:

field object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation