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 String	PARAM_PERSON_ID
static String	PARAM_SITE_ID

Method Summary

Modifier and Type	Method	Description
void	approveSiteMembershipRequest(String siteId, String inviteeId, SiteMembershipApproval siteMembershipApproval)
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.
CollectionWithPagingInfo<SiteMembershipRequest>	getPagedSiteMembershipRequests(Parameters parameters)
SiteMembershipRequest	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)
SiteMembershipRequest	updateSiteMembershipRequest(String inviteeId, SiteMembershipRequest siteInvite)	Update the site membership request for inviteeId and site

Field Detail

PARAM_SITE_ID

static final String PARAM_SITE_ID

See Also:

Constant Field Values

PARAM_PERSON_ID

static final String PARAM_PERSON_ID

See Also:

Constant Field Values

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

getPagedSiteMembershipRequests

CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(Parameters parameters)

approveSiteMembershipRequest

void approveSiteMembershipRequest(String siteId,
                                  String inviteeId,
                                  SiteMembershipApproval siteMembershipApproval)

rejectSiteMembershipRequest

void rejectSiteMembershipRequest(String siteId,
                                 String inviteeId,
                                 SiteMembershipRejection siteMembershipRejection)