inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-08 14:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c27273cb7d1b89ac3f390bd5467a3a31b6fea4bd
alfresco-ng2-components/docs/core/sites.service.md
Andy Stark ba905acf13 [ADF-2463] Moved doc files to subfolders (#3070) 
* [ADF-2463] Moved doc files to subfolders

* [ADF-2463] Fixed broken image links

* [ADF-2463] Moved doc files to subfolders

* [ADF-2463] Fixed broken image links
2018-03-13 11:55:33 +00:00

2.0 KiB
Raw Blame History

Added, Status
Added Status
v2.0.0 Active

Sites service

Accesses and manipulates sites from a Content Services repository.

Methods

  • getSites(opts: any = {}): Observable<SitePaging>
    Gets a list of all sites in the repository.
    • opts - Options supported by JSAPI
  • getSite(siteId: string, opts?: any): Observable<SiteEntry>
    Gets the details for a site.
    • siteId - ID of the target site
    • opts - (Optional) Options supported by JSAPI
  • deleteSite(siteId: string, permanentFlag: boolean = true): Observable<any>
    Deletes a site.
    • siteId - Site to delete
    • permanentFlag - True: deletion is permanent; False: site is moved to the trash
  • getSiteContent(siteId: string): Observable<SiteEntry>
    Gets a site's content.
    • siteId - ID of the target site
  • getSiteMembers(siteId: string): Observable<SiteEntry>
    Gets a list of all a site's members.
    • siteId - ID of the target site

Details

You can use getSites to get a list of all sites in the repository. The sites are returned as Observable<SiteModel[]> (see Site Model for more information about this class). If you are only interested in a single site and you have its ID, you can use getSite to access it. Alternatively, you can use getSiteContent or getSiteMembers to extract just the contents and members properties of the site.

You can also delete a site using deleteSite. If the permanentFlag parameter is set to false then the site will be moved to the trash rather than being deleted immediately.

Both getSite and getSites have an opts parameter to supply extra options. See the Alfresco JS API docs about getSites and getSite for more information about the available options.

See also