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

Method Summary

Modifier and Type	Method and Description
void	cancelSiteMembershipRequest(String inviteeId, String siteId) Cancel site membership request for invitee and site.
SiteMembershipRequest	createSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite) Create a site membership request for the user 'inviteeId'
CollectionWithPagingInfo<SiteMembershipRequest>	getPagedSiteMembershipRequests(String inviteeId, Paging paging) Get a paged list of site membership requests for inviteeId.
SiteMembershipRequest	getSiteMembershipRequest(String inviteeId, String siteId) Get the site membership request for inviteeId and siteId, if it exists.
SiteMembershipRequest	updateSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite) Update the site membership request for inviteeId and site

Method Detail

createSiteMembershipRequest

SiteMembershipRequest createSiteMembershipRequest(String inviteeId,
                                                  SiteMembershipRequest siteInvite)

Create a site membership request for the user 'inviteeId'

Parameters:

inviteeId - the site inviteee id

siteInvite - the site invite

Returns:

SiteMembershipRequest

updateSiteMembershipRequest

SiteMembershipRequest updateSiteMembershipRequest(String inviteeId,
                                                  SiteMembershipRequest siteInvite)

Update the site membership request for inviteeId and site

Parameters:

inviteeId - the site inviteee id

siteInvite - the site invite

Returns:

the updated siteMembershipRequest

cancelSiteMembershipRequest

void cancelSiteMembershipRequest(String inviteeId,
                                 String siteId)

Cancel site membership request for invitee and site.

Parameters:

inviteeId - the site inviteee id

siteId - the site id

getSiteMembershipRequest

SiteMembershipRequest getSiteMembershipRequest(String inviteeId,
                                               String siteId)

Get the site membership request for inviteeId and siteId, if it exists.

Parameters:

inviteeId - the site inviteee id

siteId - 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 inviteee id

paging - paging information

Returns:

a paged list of site membership requests