people-content.service.md

Title	Added	Status	Last reviewed
People Content service	v2.0.0	Active	2018-04-06

People Content service

Gets information about a Content Services user.

Class members

Methods

• createPerson(newPerson: PersonBodyCreate, opts?: any): Observable<EcmUserModel>
  Creates new person.

  • newPerson: PersonBodyCreate - Object containing the new person details.
  • opts: any - (Optional) Optional parameters
  • Returns Observable<EcmUserModel> - Created new person

• getCurrentPerson(): Observable<EcmUserModel>
  

  • Returns Observable<EcmUserModel> -

• getCurrentUserInfo(): Observable<EcmUserModel>
  Gets information about the current user alias -me-

  • Returns Observable<EcmUserModel> - User information

• getPerson(personId: string): Observable<EcmUserModel>
  Gets information about a user identified by their username.

  • personId: string - ID of the target user
  • Returns Observable<EcmUserModel> - User information

• getUserProfileImage(avatarId: string): string
  Returns a profile image as a URL.

  • avatarId: string - Target avatar
  • Returns string - Image URL

• isCurrentUserAdmin(): boolean
  Used to know if the current user has the admin capability

  • Returns boolean - true or false

• listPeople(requestQuery?: PeopleContentQueryRequestModel): Observable<PeopleContentQueryResponse>
  Gets a list of people.

  • requestQuery: PeopleContentQueryRequestModel - (Optional) maxItems and skipCount parameters supported by JS-API
  • Returns Observable<PeopleContentQueryResponse> - Response containing pagination and list of entries

• resetLocalCurrentUser()
  Reset the local current user object

• updatePerson(personId: string, details: PersonBodyUpdate, opts?: any): Observable<EcmUserModel>
  Updates the person details

  • personId: string - The identifier of a person
  • details: PersonBodyUpdate - The person details
  • opts: any - (Optional) Optional parameters
  • Returns Observable<EcmUserModel> - Updated person model

Details

The class returned by getPerson and getCurrentPerson is detailed in the Ecm User model docs. The avatarId passed to getUserProfileImage is available as a field of the EcmUserModel instance returned for a particular person.

See the getPerson, listPeople and createPerson methods in the Alfresco JS API for more information about the REST calls used by this service.

See also

• People process service
• Ecm user model