com.crowdin.client.stringcomments

Class StringCommentsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.stringcomments.StringCommentsApi

public class StringCommentsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<StringComment>	addStringComment(java.lang.Long projectId, AddStringCommentRequest request)
void	deleteAttachmentFromStringComment(java.lang.Long projectId, java.lang.Long commentId, java.lang.Long attachmentId)
void	deleteStringComment(java.lang.Long projectId, java.lang.Long stringCommentId)
ResponseObject<StringComment>	editStringComment(java.lang.Long projectId, java.lang.Long stringCommentId, java.util.List<PatchRequest> request)
ResponseObject<StringComment>	getStringComment(java.lang.Long projectId, java.lang.Long stringCommentId)
ResponseList<StringComment>	listStringComments(java.lang.Long projectId, java.lang.Long stringId, java.lang.Integer limit, java.lang.Integer offset, Type type, java.lang.String issueType, IssueStatus issueStatus)
ResponseList<StringComment>	listStringComments(java.lang.Long projectId, java.lang.Long stringId, java.lang.Integer limit, java.lang.Integer offset, Type type, java.lang.String issueType, IssueStatus issueStatus, java.util.List<OrderByField> orderBy)
ResponseList<StringComment>	stringCommentBatchOperations(java.lang.Long projectId, java.util.List<PatchRequest> 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

StringCommentsApi

public StringCommentsApi(Credentials credentials)

StringCommentsApi

public StringCommentsApi(Credentials credentials,
                         ClientConfig clientConfig)

Method Detail

listStringComments

public ResponseList<StringComment> listStringComments(java.lang.Long projectId,
                                                      java.lang.Long stringId,
                                                      java.lang.Integer limit,
                                                      java.lang.Integer offset,
                                                      Type type,
                                                      java.lang.String issueType,
                                                      IssueStatus issueStatus)

Parameters:

projectId - project identifier

stringId - string Identifier

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

offset - starting offset in the collection (default 0)

type - defines string comment type

issueType - defines issue type

issueStatus - defines issue resolution status

Returns:

list of string comments

See Also:

• API Documentation
• Enterprise API Documentation

listStringComments

public ResponseList<StringComment> listStringComments(java.lang.Long projectId,
                                                      java.lang.Long stringId,
                                                      java.lang.Integer limit,
                                                      java.lang.Integer offset,
                                                      Type type,
                                                      java.lang.String issueType,
                                                      IssueStatus issueStatus,
                                                      java.util.List<OrderByField> orderBy)

Parameters:

projectId - project identifier

stringId - string Identifier

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

offset - starting offset in the collection (default 0)

type - defines string comment type

issueType - defines issue type

issueStatus - defines issue resolution status

orderBy - list of OrderByField

Returns:

list of string comments

See Also:

• API Documentation
• Enterprise API Documentation

addStringComment

public ResponseObject<StringComment> addStringComment(java.lang.Long projectId,
                                                      AddStringCommentRequest request)

Parameters:

projectId - project identifier

request - request object

Returns:

newly created bundle string comment

See Also:

• API Documentation
• Enterprise API Documentation

getStringComment

public ResponseObject<StringComment> getStringComment(java.lang.Long projectId,
                                                      java.lang.Long stringCommentId)

Parameters:

projectId - project identifier

stringCommentId - string comment identifier

Returns:

string comment object

See Also:

• API Documentation
• Enterprise API Documentation

deleteStringComment

public void deleteStringComment(java.lang.Long projectId,
                                java.lang.Long stringCommentId)

Parameters:

projectId - project identifier

stringCommentId - string comment identifier

See Also:

• API Documentation
• Enterprise API Documentation

editStringComment

public ResponseObject<StringComment> editStringComment(java.lang.Long projectId,
                                                       java.lang.Long stringCommentId,
                                                       java.util.List<PatchRequest> request)

Parameters:

projectId - project identifier

stringCommentId - string comment identifier

request - request object

Returns:

updated string comment object

See Also:

• API Documentation
• Enterprise API Documentation

stringCommentBatchOperations

public ResponseList<StringComment> stringCommentBatchOperations(java.lang.Long projectId,
                                                                java.util.List<PatchRequest> request)

Parameters:

projectId - project identifier

request - request object

Returns:

list of updated string comment objects

See Also:

• API Documentation
• Enterprise API Documentation

deleteAttachmentFromStringComment

public void deleteAttachmentFromStringComment(java.lang.Long projectId,
                                              java.lang.Long commentId,
                                              java.lang.Long attachmentId)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

projectId - project identifier

commentId - comment identifier

attachmentId - attachment identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation