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<any>
  Gets information about the user who is currently logged in.

  • Returns Observable<any> - User information

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

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

• isContentAdmin(): Promise<boolean>
  

  • Returns Promise<boolean> -

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

  • requestQuery: PeopleContentQueryRequestModel - (Optional) maxItems and skipCount used for pagination
  • Returns Observable<EcmUserModel[]> - Array of people

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