Accesses and manipulates sites from a Content Services repository.
string
, inviteeId: string
, opts?: any
): Observable
<
SiteMembershipRequestWithPersonPaging
>
string
- The identifier of a site.string
- The invitee user name.any
- (Optional) Options supported by JS-APIObservable
<
SiteMembershipRequestWithPersonPaging
>
- Null response notifying when the operation is completeSiteBodyCreate
): Observable
<
SiteEntry
>
SiteBodyCreate
- SiteBodyCreate to create siteObservable
<
SiteEntry
>
- site SiteEntrystring
, siteMembershipBodyCreate: SiteMembershipBodyCreate
): Observable
<
SiteGroupEntry
>
string
- The identifier of a site.SiteMembershipBodyCreate
- The Group to add and its roleObservable
<
SiteGroupEntry
>
- Observable<SiteGroupEntry>string
, siteMembershipBodyCreate: SiteMembershipBodyCreate
, opts?: any
): Observable
<
SiteMemberEntry
>
string
- The identifier of a siteSiteMembershipBodyCreate
- The person to add and their roleany
- (Optional) Optional parametersObservable
<
SiteMemberEntry
>
- Observable<SiteMemberEntry>string
, permanentFlag: boolean
= true
): Observable
<any>
string
- Site to deleteboolean
- True: deletion is permanent; False: site is moved to the trashObservable
<any>
- Null response notifying when the operation is completestring
, groupId: string
): Observable
<void>
string
- The identifier of a site.string
- The authorityId of a group.Observable
<void>
- Observable
<void>string
, personId: string
): Observable
<void>
string
- The identifier of a site.string
- The identifier of a person.Observable
<void>
- Null response notifying when the operation is completestring
string
- Username stringstring
, opts?: any
): Observable
<
SiteEntry
|any>
string
- ID of the target siteany
- (Optional) Options supported by JS-APIObservable
<
SiteEntry
|any>
- Information about the sitestring
): Observable
<
SiteEntry
|any>
string
- ID of the target siteObservable
<
SiteEntry
|any>
- Site contentstring
, groupId: string
): Observable
<
SiteGroupEntry
>
string
- The identifier of a site.string
- The authorityId of a group.Observable
<
SiteGroupEntry
>
- Observable<SiteGroupEntry>string
): Observable
<
SiteEntry
|any>
string
- ID of the target siteObservable
<
SiteEntry
|any>
- Site membersany
): Observable
<
SiteMembershipRequestWithPersonPaging
>
any
- (Optional) Options supported by JS-APIObservable
<
SiteMembershipRequestWithPersonPaging
>
- Site membership requestsMinimalNode
): string
MinimalNode
- Node to look for parent sitestring
- Site guidany
= {}
): Observable
<
SitePaging
>
any
- Options supported by JS-APIObservable
<
SitePaging
>
- List of sitesstring
, opts?: any
): Observable
<SiteGroupPaging>
string
- The identifier of a site.any
- (Optional) Options supported by JS-APIObservable
<SiteGroupPaging>
- Observable
<SiteGroupPaging>string
, opts: any
): Observable
<
SiteMemberPaging
>
string
- ID of the target siteany
- Optional parameters supported by JS-APIObservable
<
SiteMemberPaging
>
- Observable<SiteMemberPaging>string
, inviteeId: string
, opts?: any
): Observable
<
SiteMembershipRequestWithPersonPaging
>
string
- The identifier of a site.string
- The invitee user name.any
- (Optional) Options supported by JS-APIObservable
<
SiteMembershipRequestWithPersonPaging
>
- Null response notifying when the operation is completestring
, groupId: string
, siteMembershipBodyUpdate: SiteMembershipBodyUpdate
): Observable
<
SiteGroupEntry
>
string
- The identifier of a site.string
- The authorityId of a group.SiteMembershipBodyUpdate
- The group new roleObservable
<
SiteGroupEntry
>
- Observable<SiteGroupEntry>string
, personId: string
, siteMembershipBodyUpdate: SiteMembershipBodyUpdate
, opts?: any
): Observable
<
SiteMemberEntry
>
string
- The identifier of a site.string
- The identifier of a person.SiteMembershipBodyUpdate
- The persons new roleany
- (Optional) Optional parametersObservable
<
SiteMemberEntry
>
- Observable<SiteMemberEntry>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.
© 2023 Alfresco Software, Inc. All Rights Reserved.
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.