alfresco-ng2-components/docs/people-process.service.md
Andy Stark 3b15bde49b [ADF-1586] Added docs for services (#2619)
* [ADF-1586] Added docs for services

* [ADF-1586] Removed model definitions from docs
2017-11-08 10:25:37 +00:00

2.1 KiB

People Process service

Gets information about Process Services users.

Methods

getWorkflowUsers(taskId?: string, searchWord?: string): Observable<UserProcessModel[]>
Gets information about users across all tasks.

getUserImage(user: UserProcessModel): string
Gets the profile picture URL for the specified user.

involveUserWithTask(taskId: string, idToInvolve: string): Observable<UserProcessModel[]>
Sets a user to be involved with a task.

removeInvolvedUser(taskId: string, idToRemove: string): Observable<UserProcessModel[]>
Removes a user who is currently involved with a task.

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 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 (for involveUserWithTask and removeInvolvedUser), the User Workflow API (for getWorkflowUsers) and the User API(for getUserImage).

See also