[ADF-1586] Added docs for services (#2619)

* [ADF-1586] Added docs for services

* [ADF-1586] Removed model definitions from docs
This commit is contained in:
Andy Stark
2017-11-08 10:25:37 +00:00
committed by Eugenio Romano
parent a2310336dd
commit 3b15bde49b
9 changed files with 226 additions and 6 deletions
+30
View File
@@ -0,0 +1,30 @@
# People Content service
Gets information about a Content Services user.
## Methods
`getPerson(personId: string): Observable<any>`<br/>
Gets information about a user identified by their username.
`getCurrentPerson(): Observable<any>`<br/>
Gets information about the user who is currently logged-in.
## Details
The class returned by `getPerson` and `getCurrentPerson` is detailed
in the [Ecm User model docs](ecm-user.model.md). The `avatarId` passed to
`getUserProfileImage` is available as a field of the `EcmUserModel` instance
returned for a particular person.
See the
[getPerson](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PeopleApi.md#getPerson)
method in the Alfresco JS API for more information about the REST calls used by this service.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [People process service](people-process.service.md)
- [Ecm user model](ecm-user.model.md)
<!-- seealso end -->