mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-09-17 14:21:29 +00:00
28a47e83d2
* Fetch the userInfo once loggedIn and expose the cabilibility of admin * Rollback method * Return same use if defined * Use the same pepleContent service for UserInfoCOmpnent * Remove useless import * Use interface * Use angular resolver instead of guard * Remove fdescribe * Fix linting * Regenerate doc * Improve doc * Fix optional * Fix the unit test * Fix comment * Fix lint * Fix unit * Add fetch user as part of the ssoGuard * Fix unit test after fetch * Add additional unit * Fix await
15 KiB
15 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Sites service | v2.0.0 | Active | 2018-11-13 |
Sites service
Accesses and manipulates sites from a Content Services repository.
Class members
Methods
- approveSiteMembershipRequest(siteId:
string, inviteeId:string, opts?:any):Observable<SiteMembershipRequestWithPersonPaging>
Accept site membership requests.- siteId:
string- The identifier of a site. - inviteeId:
string- The invitee user name. - opts:
any- (Optional) Options supported by JS-API - Returns
Observable<SiteMembershipRequestWithPersonPaging>- Null response notifying when the operation is complete
- siteId:
- createSite(siteBody:
SiteBodyCreate):Observable<SiteEntry>
Create a site- siteBody:
SiteBodyCreate- SiteBodyCreate to create site - Returns
Observable<SiteEntry>- site SiteEntry
- siteBody:
- createSiteGroupMembership(siteId:
string, siteMembershipBodyCreate:SiteMembershipBodyCreate):Observable<SiteGroupEntry>
Create a site membership for group- siteId:
string- The identifier of a site. - siteMembershipBodyCreate:
SiteMembershipBodyCreate- The Group to add and its role - Returns
Observable<SiteGroupEntry>- Observable<SiteGroupEntry>
- siteId:
- createSiteMembership(siteId:
string, siteMembershipBodyCreate:SiteMembershipBodyCreate, opts?:any):Observable<SiteMemberEntry>
Creates a site membership for person personId on site siteId.- siteId:
string- The identifier of a site - siteMembershipBodyCreate:
SiteMembershipBodyCreate- The person to add and their role - opts:
any- (Optional) Optional parameters - Returns
Observable<SiteMemberEntry>- Observable<SiteMemberEntry>
- siteId:
- deleteSite(siteId:
string, 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
- siteId:
- deleteSiteGroupMembership(siteId:
string, groupId:string):Observable<void>
Delete a group membership for site- siteId:
string- The identifier of a site. - groupId:
string- The authorityId of a group. - Returns
Observable<void>-Observable<void>
- siteId:
- deleteSiteMembership(siteId:
string, personId:string):Observable<void>
Delete a site membership- siteId:
string- The identifier of a site. - personId:
string- The identifier of a person. - Returns
Observable<void>- Null response notifying when the operation is complete
- siteId:
- getEcmCurrentLoggedUserName():
string
Gets the username of the user currently logged into ACS.- Returns
string- Username string
- Returns
- getSite(siteId:
string, opts?:any):Observable<SiteEntry|any>
Gets the details for a site.- siteId:
string- ID of the target site - opts:
any- (Optional) Options supported by JS-API - Returns
Observable<SiteEntry|any>- Information about the site
- siteId:
- getSiteContent(siteId:
string):Observable<SiteEntry|any>
Gets a site's content.- siteId:
string- ID of the target site - Returns
Observable<SiteEntry|any>- Site content
- siteId:
- getSiteGroupMembership(siteId:
string, groupId:string):Observable<SiteGroupEntry>
Get information about site membership of group- siteId:
string- The identifier of a site. - groupId:
string- The authorityId of a group. - Returns
Observable<SiteGroupEntry>- Observable<SiteGroupEntry>
- siteId:
- getSiteMembers(siteId:
string):Observable<SiteEntry|any>
Gets a list of all a site's members.- siteId:
string- ID of the target site - Returns
Observable<SiteEntry|any>- Site members
- siteId:
- getSiteMembershipRequests(opts?:
any):Observable<SiteMembershipRequestWithPersonPaging>
Gets a list of site membership requests.- opts:
any- (Optional) Options supported by JS-API - Returns
Observable<SiteMembershipRequestWithPersonPaging>- Site membership requests
- opts:
- getSiteNameFromNodePath(node:
MinimalNode):string
Looks for a site inside the path of a Node and returns its guid if it finds one. (return an empty string if no site is found)- node:
MinimalNode- Node to look for parent site - Returns
string- Site guid
- node:
- getSites(opts:
any={}):Observable<SitePaging>
Gets a list of all sites in the repository.- opts:
any- Options supported by JS-API - Returns
Observable<SitePaging>- List of sites
- opts:
- listSiteGroups(siteId:
string, opts?:any):Observable<SiteGroupPaging>
List group membership for site- siteId:
string- The identifier of a site. - opts:
any- (Optional) Options supported by JS-API - Returns
Observable<SiteGroupPaging>-Observable<SiteGroupPaging>
- siteId:
- listSiteMemberships(siteId:
string, opts:any):Observable<SiteMemberPaging>
Gets a list of all a site's members.- siteId:
string- ID of the target site - opts:
any- Optional parameters supported by JS-API - Returns
Observable<SiteMemberPaging>- Observable<SiteMemberPaging>
- siteId:
- rejectSiteMembershipRequest(siteId:
string, inviteeId:string, opts?:any):Observable<SiteMembershipRequestWithPersonPaging>
Reject site membership requests.- siteId:
string- The identifier of a site. - inviteeId:
string- The invitee user name. - opts:
any- (Optional) Options supported by JS-API - Returns
Observable<SiteMembershipRequestWithPersonPaging>- Null response notifying when the operation is complete
- siteId:
- updateSiteGroupMembership(siteId:
string, groupId:string, siteMembershipBodyUpdate:SiteMembershipBodyUpdate):Observable<SiteGroupEntry>
Update site membership of group- siteId:
string- The identifier of a site. - groupId:
string- The authorityId of a group. - siteMembershipBodyUpdate:
SiteMembershipBodyUpdate- The group new role - Returns
Observable<SiteGroupEntry>- Observable<SiteGroupEntry>
- siteId:
- updateSiteMembership(siteId:
string, personId:string, siteMembershipBodyUpdate:SiteMembershipBodyUpdate, opts?:any):Observable<SiteMemberEntry>
Update a site membership- siteId:
string- The identifier of a site. - personId:
string- The identifier of a person. - siteMembershipBodyUpdate:
SiteMembershipBodyUpdate- The persons new role - opts:
any- (Optional) Optional parameters - Returns
Observable<SiteMemberEntry>- Observable<SiteMemberEntry>
- siteId:
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
and
getSite
for more information about the available options.