Package org.alfresco.rest.api
Interface SiteMembershipRequests
-
- All Known Implementing Classes:
SiteMembershipRequestsImpl
public interface SiteMembershipRequests
Public REST API: centralises access to site membership requests and maps between representations.- Author:
- steveglover
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_PERSON_ID
static java.lang.String
PARAM_SITE_ID
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
approveSiteMembershipRequest(java.lang.String siteId, java.lang.String inviteeId, SiteMembershipApproval siteMembershipApproval)
void
cancelSiteMembershipRequest(java.lang.String inviteeId, java.lang.String siteId)
Cancel site membership request for invitee and site.SiteMembershipRequest
createSiteMembershipRequest(java.lang.String inviteeId, SiteMembershipRequest siteInvite)
Create a site membership request for the user 'inviteeId'CollectionWithPagingInfo<SiteMembershipRequest>
getPagedSiteMembershipRequests(java.lang.String inviteeId, Paging paging)
Get a paged list of site membership requests for inviteeId.CollectionWithPagingInfo<SiteMembershipRequest>
getPagedSiteMembershipRequests(Parameters parameters)
SiteMembershipRequest
getSiteMembershipRequest(java.lang.String inviteeId, java.lang.String siteId)
Get the site membership request for inviteeId and siteId, if it exists.void
rejectSiteMembershipRequest(java.lang.String siteId, java.lang.String inviteeId, SiteMembershipRejection siteMembershipRejection)
SiteMembershipRequest
updateSiteMembershipRequest(java.lang.String inviteeId, SiteMembershipRequest siteInvite)
Update the site membership request for inviteeId and site
-
-
-
Field Detail
-
PARAM_SITE_ID
static final java.lang.String PARAM_SITE_ID
- See Also:
- Constant Field Values
-
PARAM_PERSON_ID
static final java.lang.String PARAM_PERSON_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
createSiteMembershipRequest
SiteMembershipRequest createSiteMembershipRequest(java.lang.String inviteeId, SiteMembershipRequest siteInvite)
Create a site membership request for the user 'inviteeId'- Parameters:
inviteeId
- the site inviteee idsiteInvite
- the site invite- Returns:
- SiteMembershipRequest
-
updateSiteMembershipRequest
SiteMembershipRequest updateSiteMembershipRequest(java.lang.String inviteeId, SiteMembershipRequest siteInvite)
Update the site membership request for inviteeId and site- Parameters:
inviteeId
- the site inviteee idsiteInvite
- the site invite- Returns:
- the updated siteMembershipRequest
-
cancelSiteMembershipRequest
void cancelSiteMembershipRequest(java.lang.String inviteeId, java.lang.String siteId)
Cancel site membership request for invitee and site.- Parameters:
inviteeId
- the site inviteee idsiteId
- the site id
-
getSiteMembershipRequest
SiteMembershipRequest getSiteMembershipRequest(java.lang.String inviteeId, java.lang.String siteId)
Get the site membership request for inviteeId and siteId, if it exists.- Parameters:
inviteeId
- the site inviteee idsiteId
- the site id- Returns:
- the site membership request
-
getPagedSiteMembershipRequests
CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(java.lang.String inviteeId, Paging paging)
Get a paged list of site membership requests for inviteeId.- Parameters:
inviteeId
- the site inviteee idpaging
- paging information- Returns:
- a paged list of site membership requests
-
getPagedSiteMembershipRequests
CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(Parameters parameters)
-
approveSiteMembershipRequest
void approveSiteMembershipRequest(java.lang.String siteId, java.lang.String inviteeId, SiteMembershipApproval siteMembershipApproval)
-
rejectSiteMembershipRequest
void rejectSiteMembershipRequest(java.lang.String siteId, java.lang.String inviteeId, SiteMembershipRejection siteMembershipRejection)
-
-