Tasks.API

Class: Tasks

Tasks

new Tasks(dispatcher)

Access to the Tasks resource

Parameters:

Name	Type	Description
dispatcher	Dispatcher	The API dispatcher

Source:

• resources/tasks.js , lineno 8

Methods

create(data) → {Promise}

Creates a new task

Parameters:

Name	Type	Description
data	Object	The data for the task

Source:

• resources/tasks.js , lineno 17

Returns:

The result of the API call

Type

Promise

createInWorkspace(workspaceId, data) → {Promise}

Creates a new task in the workspace

Parameters:

Name	Type	Description
workspaceId	Number	The workspace id
data	Object	The data for the task

Source:

• resources/tasks.js , lineno 27

Returns:

The result of the API call

Type

Promise

delete(taskId) → {Promise}

Deletes a task

Parameters:

Name	Type	Description
taskId	Number	The task id

Source:

• resources/tasks.js , lineno 90

Returns:

The result of the API call

Type

Promise

findAll(params) → {Promise}

Returns all tasks that the dispatcher has access to

Parameters:

Name	Type	Argument	Description
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/tasks.js , lineno 48

Returns:

The result of the API call

Type

Promise

findById(taskId, params) → {Promise}

Returns the task

Parameters:

Name	Type	Argument	Description
taskId	Number		The task id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/tasks.js , lineno 38

Returns:

The result of the API call

Type

Promise

findByProject(projectId, params) → {Promise}

Finds a task by project

Parameters:

Name	Type	Argument	Description
projectId	Number		The project id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/tasks.js , lineno 58

Returns:

The result of the API call

Type

Promise

findByTag(tagId, params) → {Promise}

Finds a task by tag

Parameters:

Name	Type	Argument	Description
tagId	Number		The tag id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/tasks.js , lineno 69

Returns:

The result of the API call

Type

Promise

update(taskId, data) → {Promise}

Update a task

Parameters:

Name	Type	Description
taskId	Number	The task id
data	Object	The data to be sent to the workspace

Source:

• resources/tasks.js , lineno 80

Returns:

The result of the API call

Type

Promise

Generated with wicked.