Constructor
new Task(opts)
Creates a Task
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
buildCommonUrlForGettingTasksFiltered(url, projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject)
Build url for assigned, active, notified or finished methods
Parameters:
| Name | Type | Description |
|---|---|---|
url |
The main url |
|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
buildCommonUrlForGettingTasksFiltered(url, projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject)
Build url for assigned, active, notified or finished methods
Parameters:
| Name | Type | Description |
|---|---|---|
url |
The main url |
|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
create(subject, start, end, description, status, project, type, user, externalUsers, documents, folders, records, mails, owner, repeatExpression, repeatUntil, formatDate, repeatTimes, progress, reminderStartUnit, reminderStartValue, reminderEndUnit, reminderEndValue) → {Promise.<any>|Promise.<*>}
Create a task
Parameters:
| Name | Type | Description |
|---|---|---|
subject |
The subject |
|
start |
The start date |
|
end |
The end date |
|
description |
The description |
|
status |
The status id |
|
project |
The project id |
|
type |
The type id |
|
user |
The list of assigned user |
|
externalUsers |
Email list of externals users to be notified |
|
documents |
The list of uuid's of the related documents |
|
folders |
The list of uuid's of the related folders |
|
records |
The list of uuid's of the related records |
|
mails |
The list of uuid's of the related mails |
|
owner |
The user id of the owner |
|
repeatExpression |
The repeat expresion |
|
repeatUntil |
The date until must be repeated the task |
|
formatDate |
The format of the date |
|
repeatTimes |
Indicate how many times must be repeated |
|
progress |
The progress value |
|
reminderStartUnit |
The reminder start unit |
|
reminderStartValue |
The reminder value |
|
reminderEndUnit |
The reminder end unit |
|
reminderEndValue |
The end value |
Returns:
Return a task object
- Type
- Promise.<any> | Promise.<*>
create(subject, start, end, description, status, project, type, user, externalUsers, documents, folders, records, mails, owner, repeatExpression, repeatUntil, formatDate, repeatTimes, progress, reminderStartUnit, reminderStartValue, reminderEndUnit, reminderEndValue) → {Promise.<any>|Promise.<*>}
Create a task
Parameters:
| Name | Type | Description |
|---|---|---|
subject |
The subject |
|
start |
The start date |
|
end |
The end date |
|
description |
The description |
|
status |
The status id |
|
project |
The project id |
|
type |
The type id |
|
user |
The list of assigned user |
|
externalUsers |
Email list of externals users to be notified |
|
documents |
The list of uuid's of the related documents |
|
folders |
The list of uuid's of the related folders |
|
records |
The list of uuid's of the related records |
|
mails |
The list of uuid's of the related mails |
|
owner |
The user id of the owner |
|
repeatExpression |
The repeat expresion |
|
repeatUntil |
The date until must be repeated the task |
|
formatDate |
The format of the date |
|
repeatTimes |
Indicate how many times must be repeated |
|
progress |
The progress value |
|
reminderStartUnit |
The reminder start unit |
|
reminderStartValue |
The reminder value |
|
reminderEndUnit |
The reminder end unit |
|
reminderEndValue |
The end value |
Returns:
Return a task object
- Type
- Promise.<any> | Promise.<*>
createNote(taskId, text) → {Promise.<any>|Promise.<*>}
Add a note
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
|
text |
The text |
Returns:
- Type
- Promise.<any> | Promise.<*>
createNote(taskId, text) → {Promise.<any>|Promise.<*>}
Add a note
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
|
text |
The text |
Returns:
- Type
- Promise.<any> | Promise.<*>
createProject(name, active, description) → {Promise.<any>|Promise.<*>}
Add a project
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
active |
The active is true or false |
|
description |
The description project |
Returns:
- Type
- Promise.<any> | Promise.<*>
createProject(name, active, description) → {Promise.<any>|Promise.<*>}
Add a project
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
active |
The active is true or false |
|
description |
The description project |
Returns:
- Type
- Promise.<any> | Promise.<*>
createStatus(name, finish) → {Promise.<any>|Promise.<*>}
Add a status
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
finish |
The finish is true or false |
Returns:
- Type
- Promise.<any> | Promise.<*>
createStatus(name, finish) → {Promise.<any>|Promise.<*>}
Add a status
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
finish |
The finish is true or false |
Returns:
- Type
- Promise.<any> | Promise.<*>
createType(name, active, description) → {Promise.<any>|Promise.<*>}
Add a type
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
active |
The active is true or false |
|
description |
The description type |
Returns:
- Type
- Promise.<any> | Promise.<*>
createType(name, active, description) → {Promise.<any>|Promise.<*>}
Add a type
Parameters:
| Name | Type | Description |
|---|---|---|
name |
The name |
|
active |
The active is true or false |
|
description |
The description type |
Returns:
- Type
- Promise.<any> | Promise.<*>
delete(taskId) → {Promise.<any>|Promise.<*>}
Delete a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The if of the task |
Returns:
- Type
- Promise.<any> | Promise.<*>
delete(taskId) → {Promise.<any>|Promise.<*>}
Delete a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The if of the task |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteNote(noteId) → {Promise.<any>|Promise.<*>}
Delete a note of a tak
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
The note id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteNote(noteId) → {Promise.<any>|Promise.<*>}
Delete a note of a tak
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
The note id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteProject(projectId) → {Promise.<any>|Promise.<*>}
Delete a project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The project id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteProject(projectId) → {Promise.<any>|Promise.<*>}
Delete a project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The project id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteStatus(statusId) → {Promise.<any>|Promise.<*>}
Delete a status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The status id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteStatus(statusId) → {Promise.<any>|Promise.<*>}
Delete a status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The status id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteType(typeId) → {Promise.<any>|Promise.<*>}
Delete a type
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The type id |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteType(typeId) → {Promise.<any>|Promise.<*>}
Delete a type
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The type id |
Returns:
- Type
- Promise.<any> | Promise.<*>
getActive(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get active task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getActive(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get active task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getAssigned(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get assigned task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getAssigned(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get assigned task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getFinished(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get finished task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getFinished(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get finished task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getHistory(taskId) → {Promise.<*>}
Get taskHistory list
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
- Return a list of task history
- Type
- Promise.<*>
getHistory(taskId) → {Promise.<*>}
Get taskHistory list
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
- Return a list of task history
- Type
- Promise.<*>
getNotes(taskId) → {Promise.<any>|Promise.<*>}
Get the notes of a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
List of notes of a task
- Type
- Promise.<any> | Promise.<*>
getNotes(taskId) → {Promise.<any>|Promise.<*>}
Get the notes of a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
List of notes of a task
- Type
- Promise.<any> | Promise.<*>
getNotified(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get finished task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getNotified(projectId, typeId, statusId, orderColumn, orderAsc, offset, limit, subject) → {Promise.<*>}
Get finished task
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id of the project |
|
typeId |
The type of the task |
|
statusId |
The status of the task |
|
orderColumn |
Order by column |
|
orderAsc |
Order asc or desc |
|
offset |
The offset of the results |
|
limit |
The limit of the result |
|
subject |
Filter by subject |
Returns:
Return a list of assigned task to the user
- Type
- Promise.<*>
getProject(projectId) → {Promise.<*>}
Get project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The project Id |
Returns:
- Return a project
- Type
- Promise.<*>
getProject(projectId) → {Promise.<*>}
Get project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The project Id |
Returns:
- Return a project
- Type
- Promise.<*>
getProjectsActive(filterByActive) → {Promise.<*>}
Get projects list
Parameters:
| Name | Type | Description |
|---|---|---|
filterByActive |
When true, only retrieve a list of the projects what are active |
Returns:
- Return a list of project
- Type
- Promise.<*>
getProjectsActive(filterByActive) → {Promise.<*>}
Get projects list
Parameters:
| Name | Type | Description |
|---|---|---|
filterByActive |
When true, only retrieve a list of the projects what are active |
Returns:
- Return a list of project
- Type
- Promise.<*>
getRelatedTasks(uuid) → {Promise.<*>}
Get related tasks
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a node |
Returns:
Return a list with the tasks of a node
- Type
- Promise.<*>
getRelatedTasks(uuid) → {Promise.<*>}
Get related tasks
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a node |
Returns:
Return a list with the tasks of a node
- Type
- Promise.<*>
getState(statusId) → {Promise.<*>}
Get status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The status Id |
Returns:
- Return a status
- Type
- Promise.<*>
getState(statusId) → {Promise.<*>}
Get status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The status Id |
Returns:
- Return a status
- Type
- Promise.<*>
getStatus() → {Promise.<*>}
Get status list
Returns:
- Return a list of status
- Type
- Promise.<*>
getStatus() → {Promise.<*>}
Get status list
Returns:
- Return a list of status
- Type
- Promise.<*>
getTask(taskId) → {Promise.<any>|Promise.<*>}
Get task by id
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
Return task
- Type
- Promise.<any> | Promise.<*>
getTask(taskId) → {Promise.<any>|Promise.<*>}
Get task by id
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
Returns:
Return task
- Type
- Promise.<any> | Promise.<*>
getType(typeId) → {Promise.<*>}
Get type
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The type Id |
Returns:
- Return a type
- Type
- Promise.<*>
getType(typeId) → {Promise.<*>}
Get type
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The type Id |
Returns:
- Return a type
- Type
- Promise.<*>
getTypesActive(filterByActive) → {Promise.<*>}
Get types list
Parameters:
| Name | Type | Description |
|---|---|---|
filterByActive |
When true, only retrieve a list of the types what are active |
Returns:
- Return a list of types
- Type
- Promise.<*>
getTypesActive(filterByActive) → {Promise.<*>}
Get types list
Parameters:
| Name | Type | Description |
|---|---|---|
filterByActive |
When true, only retrieve a list of the types what are active |
Returns:
- Return a list of types
- Type
- Promise.<*>
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setToken(token)
Set the token in Task variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Task variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
update(taskId, subject, start, end, description, status, project, type, user, externalUsers, documents, folders, records, mails, owner, repeatExpression, repeatUntil, formatDate, repeatTimes, progress, reminderStartUnit, reminderStartValue, reminderEndUnit, reminderEndValue) → {Promise.<any>|Promise.<*>}
Update a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
|
subject |
The subject |
|
start |
The start date |
|
end |
The end date |
|
description |
The description |
|
status |
The status id |
|
project |
The project id |
|
type |
The type id |
|
user |
The list of assigned user |
|
externalUsers |
Email list of externals users to be notified |
|
documents |
The list of uuid's of the related documents |
|
folders |
The list of uuid's of the related folders |
|
records |
The list of uuid's of the related records |
|
mails |
The list of uuid's of the related mails |
|
owner |
The user id of the owner |
|
repeatExpression |
The repeat expresion |
|
repeatUntil |
The date until must be repeated the task |
|
formatDate |
The format of the date |
|
repeatTimes |
Indicate how many times must be repeated |
|
progress |
The progress value |
|
reminderStartUnit |
The reminder start unit |
|
reminderStartValue |
The reminder value |
|
reminderEndUnit |
The reminder end unit |
|
reminderEndValue |
The end value |
Returns:
Return a task object
- Type
- Promise.<any> | Promise.<*>
update(taskId, subject, start, end, description, status, project, type, user, externalUsers, documents, folders, records, mails, owner, repeatExpression, repeatUntil, formatDate, repeatTimes, progress, reminderStartUnit, reminderStartValue, reminderEndUnit, reminderEndValue) → {Promise.<any>|Promise.<*>}
Update a task
Parameters:
| Name | Type | Description |
|---|---|---|
taskId |
The task id |
|
subject |
The subject |
|
start |
The start date |
|
end |
The end date |
|
description |
The description |
|
status |
The status id |
|
project |
The project id |
|
type |
The type id |
|
user |
The list of assigned user |
|
externalUsers |
Email list of externals users to be notified |
|
documents |
The list of uuid's of the related documents |
|
folders |
The list of uuid's of the related folders |
|
records |
The list of uuid's of the related records |
|
mails |
The list of uuid's of the related mails |
|
owner |
The user id of the owner |
|
repeatExpression |
The repeat expresion |
|
repeatUntil |
The date until must be repeated the task |
|
formatDate |
The format of the date |
|
repeatTimes |
Indicate how many times must be repeated |
|
progress |
The progress value |
|
reminderStartUnit |
The reminder start unit |
|
reminderStartValue |
The reminder value |
|
reminderEndUnit |
The reminder end unit |
|
reminderEndValue |
The end value |
Returns:
Return a task object
- Type
- Promise.<any> | Promise.<*>
updateNote(noteId, text) → {Promise.<any>|Promise.<*>}
Update a note
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
The id of the note |
|
text |
The text of the note |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateNote(noteId, text) → {Promise.<any>|Promise.<*>}
Update a note
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
The id of the note |
|
text |
The text of the note |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateProject(projectId, name, active, description) → {Promise.<any>|Promise.<*>}
Update a project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id project |
|
name |
The name |
|
active |
The active is true or false |
|
description |
The description project |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateProject(projectId, name, active, description) → {Promise.<any>|Promise.<*>}
Update a project
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
The id project |
|
name |
The name |
|
active |
The active is true or false |
|
description |
The description project |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateStatus(statusId, name, finish) → {Promise.<any>|Promise.<*>}
Update a status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The id status |
|
name |
The name |
|
finish |
The finish is true or false |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateStatus(statusId, name, finish) → {Promise.<any>|Promise.<*>}
Update a status
Parameters:
| Name | Type | Description |
|---|---|---|
statusId |
The id status |
|
name |
The name |
|
finish |
The finish is true or false |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateType(typeId, name, active, description) → {Promise.<any>|Promise.<*>}
Update a project
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The id type |
|
name |
The name |
|
active |
The active is true or false |
|
description |
The description type |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateType(typeId, name, active, description) → {Promise.<any>|Promise.<*>}
Update a project
Parameters:
| Name | Type | Description |
|---|---|---|
typeId |
The id type |
|
name |
The name |
|
active |
The active is true or false |
|
description |
The description type |
Returns:
- Type
- Promise.<any> | Promise.<*>