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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
approveSiteMembershipRequest
(String siteId, String inviteeId, SiteMembershipApproval siteMembershipApproval) void
cancelSiteMembershipRequest
(String inviteeId, String siteId) Cancel site membership request for invitee and site.createSiteMembershipRequest
(String inviteeId, SiteMembershipRequest siteInvite) Create a site membership request for the user 'inviteeId'createSiteMembershipRequest
(String inviteeId, SiteMembershipRequest siteInvite, String client) Create a site membership request for the user 'inviteeId'getPagedSiteMembershipRequests
(String inviteeId, Paging paging) Get a paged list of site membership requests for inviteeId.getPagedSiteMembershipRequests
(Parameters parameters) getSiteMembershipRequest
(String inviteeId, String siteId) Get the site membership request for inviteeId and siteId, if it exists.void
rejectSiteMembershipRequest
(String siteId, String inviteeId, SiteMembershipRejection siteMembershipRejection) updateSiteMembershipRequest
(String inviteeId, SiteMembershipRequest siteInvite) Update the site membership request for inviteeId and site
-
Field Details
-
PARAM_SITE_ID
- See Also:
-
PARAM_PERSON_ID
- See Also:
-
-
Method Details
-
createSiteMembershipRequest
SiteMembershipRequest createSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite) Create a site membership request for the user 'inviteeId'- Parameters:
inviteeId
- the site invite idsiteInvite
- the site invite- Returns:
- SiteMembershipRequest
-
createSiteMembershipRequest
SiteMembershipRequest createSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite, String client) Create a site membership request for the user 'inviteeId'- Parameters:
inviteeId
- the site invitee idsiteInvite
- the site inviteclient
- the client name which is registered to send emails- Returns:
- SiteMembershipRequest
-
updateSiteMembershipRequest
SiteMembershipRequest updateSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite) Update the site membership request for inviteeId and site- Parameters:
inviteeId
- the site invite idsiteInvite
- the site invite- Returns:
- the updated siteMembershipRequest
-
cancelSiteMembershipRequest
Cancel site membership request for invitee and site.- Parameters:
inviteeId
- the site invite idsiteId
- the site id
-
getSiteMembershipRequest
Get the site membership request for inviteeId and siteId, if it exists.- Parameters:
inviteeId
- the site invite idsiteId
- the site id- Returns:
- the site membership request
-
getPagedSiteMembershipRequests
CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(String inviteeId, Paging paging) Get a paged list of site membership requests for inviteeId.- Parameters:
inviteeId
- the site invite idpaging
- paging information- Returns:
- a paged list of site membership requests
-
getPagedSiteMembershipRequests
CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(Parameters parameters) -
approveSiteMembershipRequest
void approveSiteMembershipRequest(String siteId, String inviteeId, SiteMembershipApproval siteMembershipApproval) -
rejectSiteMembershipRequest
void rejectSiteMembershipRequest(String siteId, String inviteeId, SiteMembershipRejection siteMembershipRejection)
-