mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
60 lines
4.0 KiB
Markdown
60 lines
4.0 KiB
Markdown
---
|
|
Title: Sites service
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-13
|
|
---
|
|
|
|
# [Sites service](../../lib/core/services/sites.service.ts "Defined in sites.service.ts")
|
|
|
|
Accesses and manipulates sites from a Content Services repository.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Deletes a site.
|
|
- _siteId:_ `string` - Site to delete
|
|
- _permanentFlag:_ `boolean` - True: deletion is permanent; False: site is moved to the trash
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response notifying when the operation is complete
|
|
- **getEcmCurrentLoggedUserName**(): `string`<br/>
|
|
Gets the username of the user currently logged into ACS.
|
|
- **Returns** `string` - Username string
|
|
- **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`<br/>
|
|
Gets the details for a site.
|
|
- _siteId:_ `string` - ID of the target site
|
|
- _opts:_ `any` - (Optional) Options supported by JS-API
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Information about the site
|
|
- **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`<br/>
|
|
Gets a site's content.
|
|
- _siteId:_ `string` - ID of the target site
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Site content
|
|
- **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`<br/>
|
|
Gets a list of all a site's members.
|
|
- _siteId:_ `string` - ID of the target site
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Site members
|
|
- **getSites**(opts: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>`<br/>
|
|
Gets a list of all sites in the repository.
|
|
- _opts:_ `any` - Options supported by JS-API
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites
|
|
|
|
## Details
|
|
|
|
You can use `getSites` to get a list of all sites in the repository.
|
|
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](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSites)
|
|
and
|
|
[getSite](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
|
for more information about the available options.
|