|
getSpaceByDisplayName(String spaceDisplayName) |
spaceDisplayName
| Space | Get a space whose display name matches the string input. (Since 1.2.0-GA). |
|
getSpaceByPrettyName(String spaceName) | spaceName
| Space | Get a space whose pretty name matches the string input. (Since 1.2.0-GA). |
|
getSpaceByGroupId(String groupId) |
groupId
| Space | Get a space that has group Id matching the string input. |
|
getSpaceById(String spaceId) |
spaceId | Space | Get a space by its Id. |
|
getSpaceByUrl(String spaceUrl) |
spaceUrl | Space | Get a space whose URL matches the string input. |
|
getAllSpaces() |
N/A
| ListAccess<Space> | Get a list of spaces with the type of a space list access. (Since 1.3.0-GA). |
|
getAllSpacesWithListAccess() |
N/A
| ListAccess<Space> | Get a list of spaces with the type of a space list access. (Since 1.2.0-GA). |
|
getAllSpacesByFilter(SpaceFilter spaceFilter) |
spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. These spaces matches the space filter. (Since 1.2.0-GA). |
|
getMemberSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of list access that contains all the spaces in which a user has the "member" role. (Since 1.2.0-GA). |
|
getMemberSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains the spaces which a user has the "member" role and match the provided space filter. (Since 1.2.0-GA). |
|
getAccessibleSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user has the access permission.(Since 1.3.0-GA). |
|
getAccessibleSpacesWithListAccess(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with a space list access. The list contains all the spaces that a user has the access permission. (Since 1.2.0-GA). |
|
getAccessibleSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user has the access permission and match the provided space filter. (Since 1.2.0-GA). |
|
getSettingableSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user has the setting permission. (Since 1.2.0-GA). |
|
getSettingabledSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user has the setting permission and match the provided space filter. (Since 1.2.0-GA). |
|
getInvitedSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user is invited to join. (Since 1.3.0-GA). |
|
getInvitedSpacesWithListAccess(String userId) | userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user is invited to join. (Since 1.2.0-GA). |
|
getInvitedSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user is invited to join and match the provided space filter. (Since 1.2.0-GA). |
|
getPublicSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user can request to join. (Since 1.3.0-GA). |
|
getPublicSpacesWithListAccess(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user can request to join. (Since 1.2.0-GA). |
|
getPublicSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user can request to join and match the provided space filter. (Since 1.2.0-GA). |
|
getPendingSpaces(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user sent join-request to a space. (Since 1.3.0-GA). |
|
getPendingSpacesWithListAccess(String userId) |
userId
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user sent a request for joining a space. (Since 1.2.0-GA). |
|
getPendingSpacesByFilter(String userId, SpaceFilter spaceFilter) |
userId, spaceFilter
| ListAccess<Space> | Get a list of spaces with the type of a space list access. The list contains all the spaces that a user sent join-request to a space and match the provided space filter. (Since 1.2.0-GA). |
|
createSpace(Space space, String creatorUserId) |
space, creatorUserId
| Space | Create a new space: create a group, its group navigation with pages for installing space applications. |
|
updateSpace(Space existingSpace) |
existingSpace
| Space | Update information of a space. (Since 1.2.0-GA). |
|
deleteSpace(Space space) |
space
| void | Delete a space. When deleting a space, all of its page navigation bars and its group will be deleted. |
|
addPendingUser(Space space, String userId) |
space, userId
| void | Add a user to the pending list to request to join a space. (Since 1.2.0-GA). |
|
removePendingUser(Space space, String userId) |
space, userId
| void | Remove a user from the pending list to request to join a space. (Since 1.2.0-GA). |
|
isPendingUser(Space space, String userId) |
space, userId
| void | Check if a user is in the pending list to request to join a space or not. (Since 1.2.0-GA). |
|
addInvitedUser(Space space, String userId) |
space, userId
| void | Add a user, who is invited to a space, to the invited list. (Since 1.2.0-GA). |
|
removeInvitedUser(Space space, String userId) |
space, userId
| void | Remove a user, who is invited to a space, from the invited list. (Since 1.2.0-GA). |
|
isInvitedUser(Space space, String userId) |
space, userId
| void | Check if a user invited to join a space is in the invited list or not. (Since 1.2.0-GA). |
|
addMember(Space space, String userId) |
space, userId
| void | Add a user to a space. The user will get the "member" role in that space. |
|
removeMember(Space space, String userId) |
space, userId
| void | Remove a member from a space. |
|
isMember(Space space, String userId) |
space, userId
| boolean | Check whether a user is a space's member or not. |
|
setManager(Space space, String userId, boolean isManager) |
space, userId, isManager
| void | Add a user to have the "manager" role in a space. If isManager is set to "true", a user will get the "manager" role. If false, that user will get the "member" role. (Since 1.2.0-GA). |
|
isManager(Space space, String userId) |
space, userId
| void | Check if a user has the "manager" role in a space or not. (Since 1.2.0-GA). |
|
isOnlyManager(Space space, String userId) |
space, userId
| boolean | Check if a user is the only one who has the "manager" role in a space. True if the user Id is the only one who has "manager" role in a space. Otherwise, return false. (Since 1.2.0-GA). |
|
hasAccessPermission(Space space, String userId) |
space, userId
| boolean | Check if a user can access a space or not. If the user is root or the space's member, return true. |
|
hasSettingPermission(Space space, String userId) |
space, userId
| boolean | Check if a user can have the setting permission to a space or not. If the user is root or the space's member, return true. (Since 1.2.0-GA). |
|
registerSpaceListenerPlugin(SpaceListenerPlugin spaceListenerPlugin) |
spaceListenerPlugin
| void | Register a space listener plugin to listen to space lifecyle events: creating, removing space, activating, deactiving, adding, removing application, promoting, joining, leaving, and revoking. (Since 1.2.0-GA). |
|
unregisterSpaceListenerPlugin(SpaceListenerPlugin spaceListenerPlugin) |
spaceListenerPlugin
| void | Unregister an existing space listener plugin. (Since 1.2.0-GA). |
|
setSpaceApplicationConfigPlugin(SpaceApplicationConfigPlugin spaceApplicationConfigPlugin) |
spaceApplicationConfigPlugin
| void | Set a space application configuration plugin to configure the home and space applications. By configuring this, the space service will know how to create a new page node with title, URL, and portlet to use. (Since 1.2.0-GA). |
|
getSpaceApplicationConfigPlugin() |
N/A
| SpaceApplicationConfigPlugin | Get the configuration of applications to be initialized when creating a new space. (Since 1.2.0-GA). |
|
getAllSpaces() throws SpaceException |
N/A
| List<Space> | Get all spaces in Social. You should use method getAllSpaceWithListAccess instead of getAllSpaces. It will be removed in Social 1.3.x. |
|
getSpaceByName(String spaceName) throws SpaceException |
spaceName
| Space | Get a space by its name. You should use SpaceService#getSpaceByPrettyName instead. It will be removed version 1.3.x. |
|
getSpacesByFirstCharacterOfName(String firstCharacterOfName) throws SpaceException |
firstCharacterOfName
| List<Space> | Get all spaces whose name starting with the input character. |
|
getSpacesBySearchCondition(String condition) throws Exception |
condition | List<Space> | Get all spaces which has the name or the description that matches the input condition. |
|
getSpaces(String userId) throws SpaceException |
userId | List<Space> | Get spaces of a user in which that user is a member. You should use getMemberSpaces(String) instead. It will be removed in Social 1.3.x |
|
getAccessibleSpaces(String userId) throws SpaceException |
userId
| List<Space> | Get spaces of a user which that user has the access permission. You should use getAccessibleSpacesWithListAccess(String) instead. It will be removed in Social 1.3.x. |
|
getEditableSpaces(String userId) throws SpaceException |
userId
| List<Space> | Get spaces of a user which that user has the edit permission. You should use getSettingableSpaces(String) instead. It will be removed in Social 1.3.x. |
|
getInvitedSpaces(String userId) throws SpaceException |
userId
| List<Space> | Get invited spaces of a user and that user can accept or deny the request. You should use getInvitedSpacesWithListAccess(String) instead. It will be removed in Social 1.3.x. |
|
getPublicSpaces(String userId) throws SpaceException |
userId - Id of user
| List<Space> | Get invited spaces of a user that can be accepted or denied by the user. You should use getPublicSpacesWithListAccess(String) instead. It will be removed in Social 1.3.x. |
|
getPendingSpaces(String userId) throws SpaceException |
userId
| List<Space> | Get pending spaces of a user and spaces which the user can revoke that request. You should use getPendingSpacesWithListAccess(String) instead. It will be removed in Social 1.3.x. |
|
createSpace(Space space, String creator, String invitedGroupId) throws SpaceException |
space, creator, invitedGroupId
| Space | Create a new space and invite all users from invitedGroupId to join this newly created space. |
|
saveSpace(Space space, boolean isNew) throws SpaceException |
space, isNew
| void | Save a new space or update a space. You should use updateSpace(org.exoplatform.social.core.space.model.Space) instead. It will be removed in Social 1.3.x. |
|
deleteSpace(String spaceId) throws SpaceException |
spaceId
| void | Delete a space by its id. You should use deleteSpace(org.exoplatform.social.core.space.model.Space) instead. It will be removed in Social 1.3.x. |
|
initApp(Space space) throws SpaceException |
space
| void | It is just for compatibility. Deprecated: it will be removed in Social 1.3.x. |
|
initApps(Space space) throws SpaceException |
space
| void | It is just for compatibility. Deprecated: it will be removed in Social 1.3.x. |
|
deInitApps(Space space) throws SpaceException |
space
| void | It is just for compatibility. Deprecated: it will be removed in Social 1.3.x. |
|
addMember(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Add a user to a space, the user will get the "member" role in a space. You should use addMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
removeMember(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Remove a member from a space. You should use removeMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
getMembers(Space space) throws SpaceException |
space
| List<String> | Get a list of the space members from a space. You should use Space#getMembers() instead. It will be removed in Social 1.3.x. |
|
getMembers(String spaceId) throws SpaceException |
spaceId
| List<String> | Get a list of the space members from a space. You should use Space#getMembers() instead. It will be removed in Social 1.3.x. |
|
setLeader(Space space, String userId, boolean isLeader) throws SpaceException |
space, userId, isLeader
| void | Set a member of a space as a manager. You should use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. It will be removed in Social 1.3.x. |
|
setLeader(String spaceId, String userId, boolean isLeader) throws SpaceException |
spaceId, userId, isLeader
| void | Set a member of a space as a manager. You should use setManager(org.exoplatform.social.core.space.model.Space, String, boolean) instead. It will be removed in Social 1.3.x. |
|
isLeader(Space space, String userId) throws SpaceException |
space, userId
| boolean | Check whether a user is a space's leader or not. You should use isManager(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isLeader(String spaceId, String userId) throws SpaceException |
spaceId, userId
| boolean | Check whether a user is a space's leader or not. You should use isManager(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isOnlyLeader(Space space, String userId) throws SpaceException |
space, userId
| boolean | Check whether a user is the only leader of a space or not. You should use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isOnlyLeader(String spaceId, String userId) throws SpaceException |
spaceId, userId
| boolean | Check whether a user is the only leader of a space or not. You should use isOnlyManager(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isMember(String spaceId, String userId) throws SpaceException |
spaceId, userId,
| boolean | Check whether a user is a space's member or not. You should use isMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
hasAccessPermission(String spaceId, String userId) throws SpaceException |
spaceId, userId
| boolean | Check if a user can access a space or not. You should use hasAccessPermission(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
hasEditPermission(Space space, String userId) throws SpaceException |
space, userId
| Boolean | Check if a user can have the edit permission of a space or not. You should use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
hasEditPermission(String spaceId, String userId) throws SpaceException |
spaceId, userId
| Boolean | Check if a user can have the edit permission of a space or not. You should use hasSettingPermission(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isInvited(Space space, String userId) throws SpaceException |
space, userId
| Boolean | Check if a user is in the invited list of a space or not. You should use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isInvited(String spaceId, String userId) throws SpaceException |
spaceId, userId
| Boolean | Check if a user is in the invited list of a space or not. You should use isInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isPending(Space space, String userId) throws SpaceException |
space, userId
| Boolean | Check if a user is in the pending list of a space or not.You should use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
isPending(String spaceId, String userId) throws SpaceException |
spaceId, userId
| Boolean | Check if a user is in the pending list of a space or not. You should use isPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
installApplication(String spaceId, String appId) throws SpaceException |
spaceId, appId
| void | Install an application to a space. |
|
installApplication(Space space, String appId) throws SpaceException |
space, appId
| void | Install an application to a space. |
|
activateApplication(Space space, String appId) throws SpaceException |
space, appId
| void | Activate an installed application in a space. |
|
activateApplication(String spaceId, String appId) throws SpaceException |
spaceId, appId
| void | Activate an installed application in a space. |
|
deactivateApplication(Space space, String appId) throws SpaceException |
space, appId
| void | Deactivate an installed application in a space. |
|
deactivateApplication(String spaceId, String appId) throws SpaceException |
spaceId, appId
| void | Deactivate an installed application in a space. |
|
removeApplication(Space space, String appId, String appName) throws SpaceException |
space, appId, appName
| void | Remove an installed application from a space. |
|
removeApplication(String spaceId, String appId, String appName) throws SpaceException |
space, appId, appName
| void | Remove an installed application from a space. |
|
requestJoin(Space space, String userId) throws SpaceException |
space, userId
| void | Request users to join a space. The invited users are then added to the pending list of the space. You should use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
requestJoin(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Request users to join a space. The invited users are then added to the pending list of the space.. You should use addPendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
revokeRequestJoin(Space space, String userId) throws SpaceException |
space, userId
| void | Revoke a join request after users request to join a group and is in the pending status. You should use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
revokeRequestJoin(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Revoke a request to join a space. You should use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
inviteMember(Space space, String userId) throws SpaceException |
space, userId
| void | Invite a userId to become a member of a space. You should use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
inviteMember(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Invite a userId to a be member of a space. You should use addInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
revokeInvitation(Space space, String userId) throws SpaceException |
space, userId
| void | Revoke an invitation. Remove a user from the invited member list of the space. You should use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
revokeInvitation(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Revoke an invitation. Remove a user from the invited member list of the space. You should use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
acceptInvitation(Space space, String userId) throws SpaceException |
space, userId
| void | Accept an invitation and move a user from the invited list to the member list. You should use addMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
acceptInvitation(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Accept an invitation and move a user from the invited list to the member list. You should use addMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
denyInvitation(Space space, String userId) throws SpaceException |
space, userId
| void | Deny an invitation and remove a user from the invited list. You should use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
denyInvitation(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Deny an invitation and remove a user from the invited list. You should use removeInvitedUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
validateRequest(Space space, String userId) throws SpaceException |
space, userId
| void | Validate a request and move a user from the pending list to the member list. You should use addMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
validateRequest(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Validate a request and move a user from the pending list to the member list. You should use addMember(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
declineRequest(Space space, String userId) throws SpaceException |
space, userId
| void | Decline a request and remove a user from the pending list. You should use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
declineRequest(String spaceId, String userId) throws SpaceException |
spaceId, userId
| void | Decline a request and remove a user from the pending list. You should use removePendingUser(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
registerSpaceLifeCycleListener(SpaceLifeCycleListener listener |
listener
| void | Register a space lifecycle listener. Deprecated: it will be removed in Social 1.3.x. |
|
unregisterSpaceLifeCycleListener(SpaceLifeCycleListener listener) |
listener
| void | Unregister a space lifecycle listener. Deprecated: it will be removed in Social 1.3.x. |
|
setPortletsPrefsRequired(PortletPreferenceRequiredPlugin portletPrefsRequiredPlugin) |
portletPrefsRequiredPlugin
| void | Set the portlet preferences got from the plug-in configuration. You should use SpaceApplicationConfigPlugin(org.exoplatform.social.core.space.model.Space, String) instead. It will be removed in Social 1.3.x. |
|
getPortletsPrefsRequired() |
N/A
| String | Get the portlet preferences required to use in creating the portlet application. Deprecated: it will be removed in Social 1.3.x. |