inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/core/services/people-process.service.md

2.5 KiB
Raw Permalink Blame History

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
People Process service v2.0.0 Active 2024-05-14

People Process Service

Gets information about Process Services users.

API

  • getCurrentUserInfo(): Observable<UserRepresentation>
    Gets information about the current user.
    • Returns Observable<UserRepresentation> - User information object
  • getCurrentUserProfileImage(): string
    Gets the current user's profile image as a URL.
    • Returns string - URL string
  • getUserImage(userId: string): string
    Gets a user's profile image as a URL.
    • userId: string - User ID
    • Returns string - URL string
  • getWorkflowGroups(filter: string, groupId?: string): Observable<GroupModel[]>
    Gets a list of groups in a workflow.
    • filter: string - Filter to select specific groups
    • groupId: string - (Optional) Group ID for the search
    • Returns Observable<GroupModel[]> - Array of groups
  • getWorkflowUsers(taskId?: string, searchWord?: string, groupId?: string): Observable<LightUserRepresentation[]>
    Gets information about users across all tasks.
    • taskId: string - (Optional) ID of the task
    • searchWord: string - (Optional) Filter text to search for
    • groupId: string - (Optional)
    • Returns Observable<LightUserRepresentation[]> - Array of user information objects
  • involveUserWithTask(taskId: string, idToInvolve: string): Observable<LightUserRepresentation[]>
    Sets a user to be involved with a task.
    • taskId: string - ID of the target task
    • idToInvolve: string - ID of the user to involve
    • Returns Observable<LightUserRepresentation> - Empty response when the update completes
  • removeInvolvedUser(taskId: string, idToRemove: string): Observable<LightUserRepresentation[]>
    Removes a user who is currently involved with a task.
    • taskId: string - ID of the target task
    • idToRemove: string - ID of the user to remove
    • Returns Observable<LightUserRepresentation> - Empty response when the update completes

See also