inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/core/sites.service.md

2.7 KiB
Raw Blame History

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-03-21

Sites service

Accesses and manipulates sites from a Content Services repository.

Class members

Methods

  • deleteSite(siteId: string = null, permanentFlag: boolean = true): Observable<any>
    Deletes a site.
    • siteId: string - Site to delete
    • permanentFlag: boolean - True: deletion is permanent; False: site is moved to the trash
    • Returns Observable<any> - Null response notifying when the operation is complete
  • getEcmCurrentLoggedUserName(): string
    Gets the username of the user currently logged into ACS.
    • Returns string - Username string
  • getSite(siteId: string = null, opts?: any = null): Observable<SiteEntry>
    Gets the details for a site.
    • siteId: string - ID of the target site
    • opts: any - (Optional) Options supported by JSAPI
    • Returns Observable<SiteEntry> - Information about the site
  • getSiteContent(siteId: string = null): Observable<SiteEntry>
    Gets a site's content.
    • siteId: string - ID of the target site
    • Returns Observable<SiteEntry> - Site content
  • getSiteMembers(siteId: string = null): Observable<SiteEntry>
    Gets a list of all a site's members.
    • siteId: string - ID of the target site
    • Returns Observable<SiteEntry> - Site members
  • getSites(opts: any = {}): Observable<SitePaging>
    Gets a list of all sites in the repository.
    • opts: any - Options supported by JSAPI
    • Returns Observable<SitePaging> - List of sites

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