mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1586] Added Core services docs (#2580)
This commit is contained in:
committed by
Eugenio Romano
parent
32d2497fa2
commit
ee262ee343
@@ -336,6 +336,10 @@ for more information about installing and using the source code.
|
|||||||
- [Node restore directive](node-restore.directive.md)
|
- [Node restore directive](node-restore.directive.md)
|
||||||
- [Upload directive](upload.directive.md)
|
- [Upload directive](upload.directive.md)
|
||||||
|
|
||||||
|
### Models
|
||||||
|
|
||||||
|
- [Site model](site.model.md)
|
||||||
|
|
||||||
### Pipes
|
### Pipes
|
||||||
|
|
||||||
- [File size pipe](file-size.pipe.md)
|
- [File size pipe](file-size.pipe.md)
|
||||||
@@ -357,6 +361,7 @@ for more information about installing and using the source code.
|
|||||||
- [Nodes api service](nodes-api.service.md)
|
- [Nodes api service](nodes-api.service.md)
|
||||||
- [Notification service](notification.service.md)
|
- [Notification service](notification.service.md)
|
||||||
- [Renditions service](renditions.service.md)
|
- [Renditions service](renditions.service.md)
|
||||||
|
- [Sites api service](sites-api.service.md)
|
||||||
- [Thumbnail service](thumbnail.service.md)
|
- [Thumbnail service](thumbnail.service.md)
|
||||||
- [Translation service](translation.service.md)
|
- [Translation service](translation.service.md)
|
||||||
- [Upload service](upload.service.md)
|
- [Upload service](upload.service.md)
|
||||||
@@ -379,7 +384,6 @@ for more information about installing and using the source code.
|
|||||||
- [*Search api service](../ng2-components/ng2-alfresco-core/src/services/search-api.service.ts)
|
- [*Search api service](../ng2-components/ng2-alfresco-core/src/services/search-api.service.ts)
|
||||||
- [*Search service](../ng2-components/ng2-alfresco-core/src/services/search.service.ts)
|
- [*Search service](../ng2-components/ng2-alfresco-core/src/services/search.service.ts)
|
||||||
- [*Shared links api service](../ng2-components/ng2-alfresco-core/src/services/shared-links-api.service.ts)
|
- [*Shared links api service](../ng2-components/ng2-alfresco-core/src/services/shared-links-api.service.ts)
|
||||||
- [*Sites api service](../ng2-components/ng2-alfresco-core/src/services/sites-api.service.ts)
|
|
||||||
- [*Storage service](../ng2-components/ng2-alfresco-core/src/services/storage.service.ts)
|
- [*Storage service](../ng2-components/ng2-alfresco-core/src/services/storage.service.ts)
|
||||||
- [*Translate loader service](../ng2-components/ng2-alfresco-core/src/services/translate-loader.service.ts)
|
- [*Translate loader service](../ng2-components/ng2-alfresco-core/src/services/translate-loader.service.ts)
|
||||||
<!-- ng2-alfresco-core end -->
|
<!-- ng2-alfresco-core end -->
|
||||||
@@ -575,7 +579,7 @@ for more information about installing and using the source code.
|
|||||||
|
|
||||||
### Directives
|
### Directives
|
||||||
|
|
||||||
- [*Extension viewer directive](../ng2-components/ng2-alfresco-viewer/src/directives/extension-viewer.directive.ts)
|
- [*Viewer extension directive](../ng2-components/ng2-alfresco-viewer/src/directives/viewer-extension.directive.ts)
|
||||||
<!-- ng2-alfresco-viewer end -->
|
<!-- ng2-alfresco-viewer end -->
|
||||||
|
|
||||||
[(Back to Contents)](#contents)
|
[(Back to Contents)](#contents)
|
||||||
|
@@ -82,6 +82,8 @@
|
|||||||
"renditions.service": [],
|
"renditions.service": [],
|
||||||
"search-control.component": ["search.component"],
|
"search-control.component": ["search.component"],
|
||||||
"search.component": [],
|
"search.component": [],
|
||||||
|
"site.model": [],
|
||||||
|
"sites-api.service": ["site.model"],
|
||||||
"sites-dropdown.component": [],
|
"sites-dropdown.component": [],
|
||||||
"start-process.component": [],
|
"start-process.component": [],
|
||||||
"start-task.component": [],
|
"start-task.component": [],
|
||||||
|
48
docs/site.model.md
Normal file
48
docs/site.model.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# Site model
|
||||||
|
|
||||||
|
Provides information about a site in a Content Services repository.
|
||||||
|
|
||||||
|
## Details
|
||||||
|
|
||||||
|
`SiteModel` is returned by methods from the [Sites Api service](sites-api.service.md).
|
||||||
|
Also, the
|
||||||
|
[`getSite`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
||||||
|
and
|
||||||
|
[`getSites`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSites) pages in the Alfresco JS API docs have further information about this API.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
class SiteModel {
|
||||||
|
role: string;
|
||||||
|
visibility: string;
|
||||||
|
guid: string;
|
||||||
|
description: string;
|
||||||
|
id: string;
|
||||||
|
preset: string;
|
||||||
|
title: string;
|
||||||
|
contents: SiteContentsModel[] = [];
|
||||||
|
members: SiteMembersModel[] = [];
|
||||||
|
pagination: Pagination;
|
||||||
|
}
|
||||||
|
|
||||||
|
class SiteContentsModel {
|
||||||
|
id: string;
|
||||||
|
folderId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
class SiteMembersModel {
|
||||||
|
role: string;
|
||||||
|
firstName: string;
|
||||||
|
emailNotificationsEnabled: boolean = false;
|
||||||
|
company: any;
|
||||||
|
id: string;
|
||||||
|
enable: boolean = false;
|
||||||
|
email: string;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||||
|
<!-- seealso start -->
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [Sites api service](sites-api.service.md)
|
||||||
|
<!-- seealso end -->
|
51
docs/sites-api.service.md
Normal file
51
docs/sites-api.service.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
# Sites Api service
|
||||||
|
|
||||||
|
Accesses and manipulates sites from a Content Services repository.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
`getSites(opts: any = {}): any`<br/>
|
||||||
|
Gets a list of all sites in the repository.
|
||||||
|
|
||||||
|
`getSite(siteId: string, opts?: any): any`<br/>
|
||||||
|
Gets the details for a site.
|
||||||
|
|
||||||
|
`deleteSite(siteId: string, permanentFlag: boolean = true): any`<br/>
|
||||||
|
Deletes a site.
|
||||||
|
|
||||||
|
`getSiteContent(siteId: string): Observable<any>`<br/>
|
||||||
|
Gets a site's content.
|
||||||
|
|
||||||
|
`getSiteMembers(siteId: string): Observable<any>`<br/>
|
||||||
|
Gets a list of all a site's members.
|
||||||
|
|
||||||
|
## 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](site.model.md) 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](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.
|
||||||
|
|
||||||
|
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||||
|
<!-- seealso start -->
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [Site model](site.model.md)
|
||||||
|
<!-- seealso end -->
|
||||||
|
|
||||||
|
|
||||||
|
|
Reference in New Issue
Block a user