com.crowdin.client.applications

Class ApplicationsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.applications.ApplicationsApi

public class ApplicationsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>>	addApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request)
void	deleteApplicationData(java.lang.String applicationIdentifier, java.lang.String path)
void	deleteApplicationInstallation(java.lang.String identifier)
void	deleteApplicationInstallation(java.lang.String identifier, java.lang.Boolean force)
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>>	editApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request)
ResponseObject<ApplicationInstallation>	editApplicationInstallation(java.lang.String identifier, java.util.List<PatchRequest> request)
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>>	getApplicationData(java.lang.String applicationIdentifier, java.lang.String path)
ResponseObject<ApplicationInstallation>	getApplicationInstallation(java.lang.String identifier)
ResponseObject<ApplicationInstallation>	installApplication(InstallApplicationRequest request)
ResponseList<ApplicationInstallation>	listApplicationInstallations(java.lang.Integer limit, java.lang.Integer offset)
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>>	updateOrRestoreApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> 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

ApplicationsApi

public ApplicationsApi(Credentials credentials)

ApplicationsApi

public ApplicationsApi(Credentials credentials,
                       ClientConfig clientConfig)

Method Detail

getApplicationData

public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> getApplicationData(java.lang.String applicationIdentifier,
                                                                                           java.lang.String path)
                                                                                    throws HttpException,
                                                                                           HttpBadRequestException

Parameters:

applicationIdentifier - identifier of the application

path - The path is implemented by the application

Returns:

application data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

updateOrRestoreApplicationData

public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> updateOrRestoreApplicationData(java.lang.String applicationIdentifier,
                                                                                                       java.lang.String path,
                                                                                                       java.util.Map<java.lang.String,java.lang.Object> request)
                                                                                                throws HttpException,
                                                                                                       HttpBadRequestException

Parameters:

applicationIdentifier - identifier of the application

path - The path is implemented by the application

request - request object

Returns:

application data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addApplicationData

public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> addApplicationData(java.lang.String applicationIdentifier,
                                                                                           java.lang.String path,
                                                                                           java.util.Map<java.lang.String,java.lang.Object> request)
                                                                                    throws HttpException,
                                                                                           HttpBadRequestException

Parameters:

applicationIdentifier - identifier of the application

path - The path is implemented by the application

request - request object

Returns:

application data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteApplicationData

public void deleteApplicationData(java.lang.String applicationIdentifier,
                                  java.lang.String path)
                           throws HttpException,
                                  HttpBadRequestException

Parameters:

applicationIdentifier - identifier of the application

path - The path is implemented by the application

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editApplicationData

public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> editApplicationData(java.lang.String applicationIdentifier,
                                                                                            java.lang.String path,
                                                                                            java.util.Map<java.lang.String,java.lang.Object> request)
                                                                                     throws HttpException,
                                                                                            HttpBadRequestException

Parameters:

applicationIdentifier - identifier of the application

path - The path is implemented by the application

request - request object

Returns:

application data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getApplicationInstallation

public ResponseObject<ApplicationInstallation> getApplicationInstallation(java.lang.String identifier)
                                                                   throws HttpException,
                                                                          HttpBadRequestException

Parameters:

identifier - identifier of the application installation

Returns:

application installation data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listApplicationInstallations

public ResponseList<ApplicationInstallation> listApplicationInstallations(java.lang.Integer limit,
                                                                          java.lang.Integer offset)
                                                                   throws HttpException,
                                                                          HttpBadRequestException

Parameters:

limit - A maximum number of items to retrieve

offset - A starting offset in the collection

Returns:

application installation data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

installApplication

public ResponseObject<ApplicationInstallation> installApplication(InstallApplicationRequest request)
                                                           throws HttpException,
                                                                  HttpBadRequestException

Parameters:

request - request object

Returns:

application installation data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteApplicationInstallation

public void deleteApplicationInstallation(java.lang.String identifier)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

identifier - identifier of the application installation

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteApplicationInstallation

public void deleteApplicationInstallation(java.lang.String identifier,
                                          java.lang.Boolean force)
                                   throws HttpException,
                                          HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

editApplicationInstallation

public ResponseObject<ApplicationInstallation> editApplicationInstallation(java.lang.String identifier,
                                                                           java.util.List<PatchRequest> request)
                                                                    throws HttpException,
                                                                           HttpBadRequestException

Parameters:

identifier - identifier of the application installation

request - request object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation