mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Manual fixes to core doc file links * [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
committed by
Eugenio Romano
parent
285e56e9fb
commit
5fc05da7aa
38
docs/core/services/people-content.service.md
Normal file
38
docs/core/services/people-content.service.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
Title: People Content service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-06
|
||||
---
|
||||
|
||||
# [People Content service](../../../lib/core/services/people-content.service.ts "Defined in people-content.service.ts")
|
||||
|
||||
Gets information about a Content Services user.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Gets information about the user who is currently logged in.
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - User information
|
||||
- **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Gets information about a user identified by their username.
|
||||
- _personId:_ `string` - ID of the target user
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - User information
|
||||
|
||||
## Details
|
||||
|
||||
The class returned by `getPerson` and `getCurrentPerson` is detailed
|
||||
in the [Ecm User model docs](../models/ecm-user.model.md). The `avatarId` passed to
|
||||
`getUserProfileImage` is available as a field of the [`EcmUserModel`](../../core/models/ecm-user.model.md) 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.
|
||||
|
||||
## See also
|
||||
|
||||
- [People process service](people-process.service.md)
|
||||
- [Ecm user model](../models/ecm-user.model.md)
|
Reference in New Issue
Block a user