com.adobe.cq.social.group.client.endpoints

Interface CommunityGroupOperations

All Known Implementing Classes:

AbstractCommunityGroupOperationService

public interface CommunityGroupOperations

Method Summary

Modifier and Type	Method and Description
boolean	approveJoin(ResourceResolver resolver, CommunityGroup group)
Resource	create(SlingHttpServletRequest request)
Resource	demoteMember(SlingHttpServletRequest request)
java.util.List<java.lang.Object>	getAllowedTemplateForEveryone(java.lang.String[] paths)
SocialComponent	getCommunityGroupComponentForResource(Resource communityGroup, SlingHttpServletRequest request) SlingHttpServletRequest.
SocialComponent	getCommunityMemberListComponentForResource(Resource communityGroup, SlingHttpServletRequest request)
Resource	invite(SlingHttpServletRequest request)
boolean	isPublishMode() Check if the aem instance is in publish mode
Resource	join(SlingHttpServletRequest request)
Resource	leave(SlingHttpServletRequest request)
Resource	promoteMember(SlingHttpServletRequest request)
Resource	uninvite(SlingHttpServletRequest request)
Resource	update(SlingHttpServletRequest request) Update the group with the specified parameters of the SlingHttpServletRequest

Method Detail

create

Resource create(SlingHttpServletRequest request)
         throws OperationException

Throws:

OperationException

join

Resource join(SlingHttpServletRequest request)
       throws OperationException

Throws:

OperationException

leave

Resource leave(SlingHttpServletRequest request)
        throws OperationException

Throws:

OperationException

invite

Resource invite(SlingHttpServletRequest request)
         throws OperationException

Throws:

OperationException

uninvite

Resource uninvite(SlingHttpServletRequest request)
           throws OperationException

Throws:

OperationException

promoteMember

Resource promoteMember(SlingHttpServletRequest request)
                throws OperationException

Throws:

OperationException

demoteMember

Resource demoteMember(SlingHttpServletRequest request)
               throws OperationException

Throws:

OperationException

approveJoin

boolean approveJoin(ResourceResolver resolver,
                    CommunityGroup group)
             throws OperationException

Throws:

OperationException

getAllowedTemplateForEveryone

java.util.List<java.lang.Object> getAllowedTemplateForEveryone(java.lang.String[] paths)

isPublishMode

boolean isPublishMode()

Check if the aem instance is in publish mode

Returns:

true if published mode

getCommunityGroupComponentForResource

SocialComponent getCommunityGroupComponentForResource(Resource communityGroup,
                                                      SlingHttpServletRequest request)

SlingHttpServletRequest.

Parameters:

communityGroup - the target community group

request - the client request

Returns:

the SocialComponent

getCommunityMemberListComponentForResource

SocialComponent getCommunityMemberListComponentForResource(Resource communityGroup,
                                                           SlingHttpServletRequest request)

update

Resource update(SlingHttpServletRequest request)
         throws OperationException

Update the group with the specified parameters of the SlingHttpServletRequest

Parameters:

request - SlingHttpServletRequest.

Returns:

resource.

Throws:

OperationException - - throws if not able to update.