inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

22
lib/core/services/sites.service.ts
View File

@@ -29,6 +29,10 @@ export class SitesService {
constructor(
private apiService: AlfrescoApiService) { }
/**
* Gets a list of all sites in the repository.
* @param opts Options supported by JSAPI
*/
getSites(opts: any = {}): Observable<SitePaging> {
const defaultOptions = {
skipCount: 0,
@@ -39,11 +43,21 @@ export class SitesService {
.catch(this.handleError);
}
/**
* Gets the details for a site.
* @param siteId ID of the target site
* @param opts Options supported by JSAPI
*/
getSite(siteId: string, opts?: any): Observable<SiteEntry> {
return Observable.fromPromise(this.apiService.getInstance().core.sitesApi.getSite(siteId, opts))
.catch(this.handleError);
}
/**
* Deletes a site.
* @param siteId Site to delete
* @param permanentFlag True: deletion is permanent; False: site is moved to the trash
*/
deleteSite(siteId: string, permanentFlag: boolean = true): Observable<any> {
let options: any = {};
options.permanent = permanentFlag;
@@ -51,10 +65,18 @@ export class SitesService {
.catch(this.handleError));
}
/**
* Gets a site's content.
* @param siteId ID of the target site
*/
getSiteContent(siteId: string): Observable<SiteEntry> {
return this.getSite(siteId, { relations: ['containers'] });
}
/**
* Gets a list of all a site's members.
* @param siteId ID of the target site
*/
getSiteMembers(siteId: string): Observable<SiteEntry> {
return this.getSite(siteId, { relations: ['members'] });
}