mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
1d517d3a8a
* [ADF-2557] Updated docs for services with new props script * [ADF-2557] Updated service docs with new props script
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-04-05
|
|
---
|
|
|
|
# Comment Process service
|
|
|
|
Adds and retrieves comments for task and process instances in Process Services.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- `addProcessInstanceComment(processInstanceId: string = null, message: string = null): Observable<CommentModel>`<br/>
|
|
Adds a comment to a process instance.
|
|
- `processInstanceId: string = null` - ID of the target process instance
|
|
- `message: string = null` - Text for the comment
|
|
- **Returns** `Observable<CommentModel>` - Details of the comment added
|
|
- `addTaskComment(taskId: string = null, message: string = null): Observable<CommentModel>`<br/>
|
|
Adds a comment to a task.
|
|
- `taskId: string = null` - ID of the target task
|
|
- `message: string = null` - Text for the comment
|
|
- **Returns** `Observable<CommentModel>` - Details about the comment
|
|
- `getProcessInstanceComments(processInstanceId: string = null): Observable<CommentModel[]>`<br/>
|
|
Gets all comments that have been added to a process instance.
|
|
- `processInstanceId: string = null` - ID of the target process instance
|
|
- **Returns** `Observable<CommentModel[]>` - Details for each comment
|
|
- `getTaskComments(taskId: string = null): Observable<CommentModel[]>`<br/>
|
|
Gets all comments that have been added to a task.
|
|
- `taskId: string = null` - ID of the target task
|
|
- **Returns** `Observable<CommentModel[]>` - Details for each comment
|
|
|
|
## 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.
|
|
|
|
## See also
|
|
|
|
- [Comment process model](comment-process.model.md)
|