[ADF-1769] Added JSDocs for services (#2949)

This commit is contained in:
Andy Stark
2018-02-14 14:20:10 +00:00
committed by Eugenio Romano
parent 8bfac2f9f8
commit 9887d8bca4
16 changed files with 182 additions and 54 deletions

View File

@@ -29,6 +29,10 @@ export class PeopleContentService {
return this.apiService.getInstance().core.peopleApi;
}
/**
* Gets information about a user identified by their username.
* @param personId ID of the target user
*/
getPerson(personId: string): Observable<any> {
const { peopleApi, handleError } = this;
const promise = peopleApi.getPerson(personId);
@@ -38,6 +42,7 @@ export class PeopleContentService {
.catch(handleError);
}
/** Gets information about the user who is currently logged-in. */
getCurrentPerson(): Observable<any> {
return this.getPerson('-me-');
}