mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
1d517d3a8a
* [ADF-2557] Updated docs for services with new props script * [ADF-2557] Updated service docs with new props script
58 lines
2.9 KiB
Markdown
58 lines
2.9 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-04-05
|
|
---
|
|
|
|
# People Process service
|
|
|
|
Gets information about Process Services users.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- `getUserImage(user: UserProcessModel = null): string`<br/>
|
|
Gets the profile picture URL for the specified user.
|
|
- `user: UserProcessModel = null` - The target user
|
|
- **Returns** `string` - Profile picture URL
|
|
- `getWorkflowUsers(taskId?: string = null, searchWord?: string = null): Observable<UserProcessModel[]>`<br/>
|
|
Gets information about users across all tasks.
|
|
- `taskId?: string = null` - (Optional) ID of the task
|
|
- `searchWord?: string = null` - (Optional) Filter text to search for
|
|
- **Returns** `Observable<UserProcessModel[]>` - Array of user information objects
|
|
- `involveUserWithTask(taskId: string = null, idToInvolve: string = null): Observable<UserProcessModel[]>`<br/>
|
|
Sets a user to be involved with a task.
|
|
- `taskId: string = null` - ID of the target task
|
|
- `idToInvolve: string = null` - ID of the user to involve
|
|
- **Returns** `Observable<UserProcessModel[]>` - Empty response when the update completes
|
|
- `removeInvolvedUser(taskId: string = null, idToRemove: string = null): Observable<UserProcessModel[]>`<br/>
|
|
Removes a user who is currently involved with a task.
|
|
- `taskId: string = null` - ID of the target task
|
|
- `idToRemove: string = null` - ID of the user to remove
|
|
- **Returns** `Observable<UserProcessModel[]>` - Empty response when the update completes
|
|
|
|
## Details
|
|
|
|
Use `getWorkflowUsers` to find users across all tasks, optionally filtering by the `searchWord`
|
|
in the task name. The `taskId` parameter, if used, specifies a task to be _excluded_ from the
|
|
results. You would typically use this feature to find new users to assign to a task, in which
|
|
case you would want to exclude users already assigned to that task.
|
|
|
|
The [User Process model](user-process.model.md) class used by the methods is seen throughout
|
|
ADF's Process Services features. Note that for `involveUserWithTask` and `removeInvolvedUser`,
|
|
null data is returned rather than usable details about users.
|
|
|
|
You can find more information about the REST API methods used by this service in the
|
|
[Task Actions API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/TaskActionsApi.md#involveUser)
|
|
(for `involveUserWithTask` and `removeInvolvedUser`), the
|
|
[User Workflow API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UsersWorkflowApi.md#getUsers)
|
|
(for `getWorkflowUsers`) and the
|
|
[User API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserApi.md#getuserprofilepictureurl)(for `getUserImage`).
|
|
|
|
## See also
|
|
|
|
- [User process model](user-process.model.md)
|
|
- [Bpm user model](bpm-user.model.md)
|
|
- [People content service](people-content.service.md)
|