4.3 KiB
Title, Added, Status, Last reviewed
| 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
- newPerson:
-
getCurrentPerson():
Observable<any>
Gets information about the user who is currently logged in.- Returns
Observable<any>- User information
- Returns
-
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
- personId:
-
isContentAdmin():
Promise<boolean>- Returns
Promise<boolean>-
- Returns
-
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
- requestQuery:
-
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
- personId:
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.