Andy Stark 87101d4e85 [ADF-2201] Search Configuration doc (#2876)
* [ADF-2201] Updated search component docs and tidied index page

* [ADF-2201] Fixed incorrect link

* [ADF-2201] Updated docs based on feedback

* [ADF-2201] Fixed broken relative link
2018-01-24 19:23:50 +01:00

46 lines
1.1 KiB
Markdown

# Site model
Provides information about a site in a Content Services repository.
## Details
`SiteModel` is returned by methods from the [Sites Api service](sites.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;
}
```
## See also
- [Sites service](sites.service.md)