com.crowdin.client.tasks

Class TasksApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.tasks.TasksApi

public class TasksApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Task>	addTask(java.lang.Long projectId, AddTaskRequest request)
ResponseObject<TaskComment>	addTaskComment(java.lang.Long projectId, java.lang.Long taskId, CreateTaskCommentRequest request)
ResponseObject<TaskSettingsTemplate>	addTaskSettingsTemplate(java.lang.Long projectId, AddTaskSettingsTemplateRequest request)
void	deleteTask(java.lang.Long projectId, java.lang.Long taskId)
void	deleteTaskComment(java.lang.Long projectId, java.lang.Long taskId, java.lang.Long commentId)
void	deleteTaskSettingsTemplate(java.lang.Long projectId, java.lang.Long taskSettingsTemplateId)
ResponseObject<Task>	editTask(java.lang.Long projectId, java.lang.Long taskId, java.util.List<PatchRequest> request)
ResponseObject<Task>	editTaskArchivedStatus(java.lang.Long taskId, java.lang.Long projectId, java.util.List<PatchRequest> request)
ResponseObject<TaskComment>	editTaskComment(java.lang.Long projectId, java.lang.Long taskId, java.lang.Long commentId, java.util.List<PatchRequest> request)
ResponseObject<TaskSettingsTemplate>	editTaskSettingsTemplate(java.lang.Long projectId, java.lang.Long taskSettingsTemplateId, java.util.List<PatchRequest> request)
ResponseObject<DownloadLink>	exportTaskStrings(java.lang.Long projectId, java.lang.Long taskId)
ResponseObject<Task>	getTask(java.lang.Long projectId, java.lang.Long taskId)
ResponseObject<TaskComment>	getTaskComment(java.lang.Long projectId, java.lang.Long taskId, java.lang.Long commentId)
ResponseObject<TaskSettingsTemplate>	getTaskSettingsTemplate(java.lang.Long projectId, java.lang.Long taskSettingsTemplateId)
ResponseList<Task>	listTasks(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset, Status status, java.lang.Integer assigneeId)
ResponseList<Task>	listTasks(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset, Status status, java.lang.Integer assigneeId, java.util.List<OrderByField> orderBy)
ResponseList<Task>	listTasks(java.lang.Long projectId, ListTasksParams params) Lists tasks for a given project, filtered by multiple statuses.
ResponseList<TaskComment>	listTasksComments(java.lang.Long projectId, java.lang.Long taskId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<TaskSettingsTemplate>	listTaskSettingsTemplates(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Task>	listUserTasks(java.lang.Integer limit, java.lang.Integer offset, Status status, BooleanInt isArchived)
ResponseList<Task>	listUserTasks(java.lang.Integer limit, java.lang.Integer offset, Status status, BooleanInt isArchived, java.util.List<OrderByField> orderBy)

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

TasksApi

public TasksApi(Credentials credentials)

TasksApi

public TasksApi(Credentials credentials,
                ClientConfig clientConfig)

Method Detail

listTasks

public ResponseList<Task> listTasks(java.lang.Long projectId,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset,
                                    Status status,
                                    java.lang.Integer assigneeId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

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

offset - starting offset in the collection (default 0)

status - filter by status

assigneeId - filter by assignee id

Returns:

list of tasks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTasks

public ResponseList<Task> listTasks(java.lang.Long projectId,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset,
                                    Status status,
                                    java.lang.Integer assigneeId,
                                    java.util.List<OrderByField> orderBy)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

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

offset - starting offset in the collection (default 0)

status - filter by status

assigneeId - filter by assignee id

orderBy - list of OrderByField

Returns:

list of tasks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTasks

public ResponseList<Task> listTasks(java.lang.Long projectId,
                                    ListTasksParams params)
                             throws HttpException,
                                    HttpBadRequestException

Lists tasks for a given project, filtered by multiple statuses.

Parameters:

projectId - project identifier

params - Query params

Returns:

List of tasks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addTask

public ResponseObject<Task> addTask(java.lang.Long projectId,
                                    AddTaskRequest request)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created task

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportTaskStrings

public ResponseObject<DownloadLink> exportTaskStrings(java.lang.Long projectId,
                                                      java.lang.Long taskId)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

Returns:

url for task strings

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTask

public ResponseObject<Task> getTask(java.lang.Long projectId,
                                    java.lang.Long taskId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

Returns:

task

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTask

public void deleteTask(java.lang.Long projectId,
                       java.lang.Long taskId)
                throws HttpException,
                       HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTask

public ResponseObject<Task> editTask(java.lang.Long projectId,
                                     java.lang.Long taskId,
                                     java.util.List<PatchRequest> request)
                              throws HttpException,
                                     HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

request - request object

Returns:

updated task

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listUserTasks

public ResponseList<Task> listUserTasks(java.lang.Integer limit,
                                        java.lang.Integer offset,
                                        Status status,
                                        BooleanInt isArchived)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

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

offset - starting offset in the collection (default 0)

status - filter by status

isArchived - filter by archived status

Returns:

list of user tasks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listUserTasks

public ResponseList<Task> listUserTasks(java.lang.Integer limit,
                                        java.lang.Integer offset,
                                        Status status,
                                        BooleanInt isArchived,
                                        java.util.List<OrderByField> orderBy)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

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

offset - starting offset in the collection (default 0)

status - filter by status

isArchived - filter by archived status

orderBy - list of OrderByField

Returns:

list of user tasks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTaskArchivedStatus

public ResponseObject<Task> editTaskArchivedStatus(java.lang.Long taskId,
                                                   java.lang.Long projectId,
                                                   java.util.List<PatchRequest> request)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

taskId - task identifier

projectId - project identifier (filter)

request - request object (only for archived flag)

Returns:

updated archived status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTaskSettingsTemplates

public ResponseList<TaskSettingsTemplate> listTaskSettingsTemplates(java.lang.Long projectId,
                                                                    java.lang.Integer limit,
                                                                    java.lang.Integer offset)

Parameters:

projectId - project identifier (filter)

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

offset - starting offset in the collection (default 0)

Returns:

list of task settings templates

See Also:

• API Documentation
• Enterprise API Documentation

addTaskSettingsTemplate

public ResponseObject<TaskSettingsTemplate> addTaskSettingsTemplate(java.lang.Long projectId,
                                                                    AddTaskSettingsTemplateRequest request)

Parameters:

projectId - project identifier

request - request object

Returns:

newly created task settings template

See Also:

• API Documentation
• Enterprise API Documentation

getTaskSettingsTemplate

public ResponseObject<TaskSettingsTemplate> getTaskSettingsTemplate(java.lang.Long projectId,
                                                                    java.lang.Long taskSettingsTemplateId)

Parameters:

projectId - project identifier

taskSettingsTemplateId - task settings template identifier

Returns:

task settings template

See Also:

• API Documentation
• Enterprise API Documentation

deleteTaskSettingsTemplate

public void deleteTaskSettingsTemplate(java.lang.Long projectId,
                                       java.lang.Long taskSettingsTemplateId)

Parameters:

projectId - project identifier

taskSettingsTemplateId - task settings template identifier

See Also:

• API Documentation
• Enterprise API Documentation

editTaskSettingsTemplate

public ResponseObject<TaskSettingsTemplate> editTaskSettingsTemplate(java.lang.Long projectId,
                                                                     java.lang.Long taskSettingsTemplateId,
                                                                     java.util.List<PatchRequest> request)

Parameters:

projectId - project identifier

taskSettingsTemplateId - task settings template identifier

request - request object

Returns:

updated task settings template

See Also:

• API Documentation
• Enterprise API Documentation

listTasksComments

public ResponseList<TaskComment> listTasksComments(java.lang.Long projectId,
                                                   java.lang.Long taskId,
                                                   java.lang.Integer limit,
                                                   java.lang.Integer offset)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of task comments

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addTaskComment

public ResponseObject<TaskComment> addTaskComment(java.lang.Long projectId,
                                                  java.lang.Long taskId,
                                                  CreateTaskCommentRequest request)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

request - request object

Returns:

newly created task comment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTaskComment

public ResponseObject<TaskComment> getTaskComment(java.lang.Long projectId,
                                                  java.lang.Long taskId,
                                                  java.lang.Long commentId)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

commentId - comment identifier

Returns:

task comment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTaskComment

public void deleteTaskComment(java.lang.Long projectId,
                              java.lang.Long taskId,
                              java.lang.Long commentId)
                       throws HttpException,
                              HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

commentId - task identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTaskComment

public ResponseObject<TaskComment> editTaskComment(java.lang.Long projectId,
                                                   java.lang.Long taskId,
                                                   java.lang.Long commentId,
                                                   java.util.List<PatchRequest> request)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

taskId - task identifier

commentId - task identifier

request - request object

Returns:

updated task comment

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation