[ADF-1586] Added Core services docs (#2587)

This commit is contained in:
Andy Stark
2017-11-01 16:22:16 +00:00
committed by Eugenio Romano
parent 3c7122ddab
commit 3fa2dee3a0
7 changed files with 177 additions and 6 deletions

View File

@@ -0,0 +1,34 @@
# Comment Process service
Adds and retrieves comments for task and process instances in Process Services.
## Methods
`addTaskComment(taskId: string, message: string): Observable<CommentProcessModel>`<br/>
Adds a comment to a task.
`getTaskComments(taskId: string): Observable<CommentProcessModel[]>`<br/>
Gets all comments that have been added to a task.
`addProcessInstanceComment(processInstanceId: string, message: string): Observable<CommentProcessModel>`<br/>
Adds a comment to a process instance.
`getProcessInstanceComments(processInstanceId: string): Observable<CommentProcessModel[]>`<br/>
Gets all comments that have been added to a process instance.
## Details
See the [Comment Process model](comment-process.model.md) for more information about the
comments returned by the methods of this service. Also, the Comments API section of the
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api)
has further details about the underlying REST API.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Comment process model](comment-process.model.md)
<!-- seealso end -->