alfresco-ng2-components/docs/core/ecm-user.service.md
Andy Stark 1d517d3a8a [ADF-2557] Updated docs with new props script (#3149)
* [ADF-2557] Updated docs for services with new props script

* [ADF-2557] Updated service docs with new props script
2018-04-08 16:23:04 +01:00

1.3 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-04-05

Ecm User service

Gets information about a Content Services user.

Class members

Methods

  • getCurrentUserInfo(): any
    Gets information about the user who is currently logged-in.
    • Returns any - User information as for getUserInfo
  • getUserInfo(userName: string = null): Observable<EcmUserModel>
    Gets information about a user identified by their username.
    • userName: string = null - Target username
    • Returns Observable<EcmUserModel> - User information
  • getUserProfileImage(avatarId: string = null): string
    Returns a profile image as a URL.
    • avatarId: string = null - Target avatar
    • Returns string - Image URL

Details

The class returned by getUserInfo and getCurrentUserInfo 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 method in the Alfresco JS API for more information about the REST calls used by this service.

See also