org.exoplatform.social.service.rest

Class NotificationsRestService

java.lang.Object

org.exoplatform.social.service.rest.NotificationsRestService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class NotificationsRestService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Provides REST Services for manipulating jobs related to notifications.

eXo anchor for generated doc on REST API

NotificationRestService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationsRestService.URL_TYPE

Constructor Summary

Constructors

Constructor and Description
NotificationsRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acceptInvitationToJoinSpace(String spaceId, String userId) Processes the "Accept the invitation to join a space" action and redirects to the space homepage.
javax.ws.rs.core.Response	confirmInvitationToConnect(String senderId, String receiverId) Processes the "Accept the invitation to connect" action between 2 users, then redirects to the sender's activity stream.
org.exoplatform.social.core.space.spi.SpaceService	getSpaceService() Gets a service which manages all things related to spaces.
javax.ws.rs.core.Response	ignoreInvitationToConnect(String senderId, String receiverId) Processes the "Deny the invitation to connect" action between 2 users, then redirects to the receiver's page of received invitations.
javax.ws.rs.core.Response	ignoreInvitationToJoinSpace(String spaceId, String userId) Processes the "Deny the invitation to join a space" action, then redirects to the page of all spaces.
javax.ws.rs.core.Response	inviteToConnect(javax.ws.rs.core.UriInfo uriInfo, String receiverId, String senderId) Processes the "Invite to connect" action between two users, sender and receiver, then redirects to the receiver's profile page.
javax.ws.rs.core.Response	redirectUrl(javax.ws.rs.core.UriInfo uriInfo, String type, String objectId) Redirects the current user to an associated page, such as user activity stream, portal homepage, space homepage and user profile.
javax.ws.rs.core.Response	refuseRequestToJoinSpace(String spaceId, String userId) Refuses a user's request for joining a space, then redirects to the space's members page.
javax.ws.rs.core.Response	validateRequestToJoinSpace(String spaceId, String userId) Adds a member to a space, then redirects to the space's members page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationsRestService

public NotificationsRestService()

Method Detail

inviteToConnect

public javax.ws.rs.core.Response inviteToConnect(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String receiverId,
                                                 String senderId)
                                          throws Exception

Processes the "Invite to connect" action between two users, sender and receiver, then redirects to the receiver's profile page.

Parameters:

senderId - The sender's remote Id.

receiverId - The receiver's remote Id.

Returns:

Redirects to the receiver's profile page.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: http://localhost:8080/rest/social/notifications/inviteToConnect/john/root

eXo authentication for generated doc on REST API

confirmInvitationToConnect

public javax.ws.rs.core.Response confirmInvitationToConnect(String senderId,
                                                            String receiverId)
                                                     throws Exception

Processes the "Accept the invitation to connect" action between 2 users, then redirects to the sender's activity stream.

Parameters:

senderId - The sender's remote Id.

receiverId - The receiver's remote Id.

Returns:

Redirects to the sender's activity stream.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: http://localhost:8080/rest/social/notifications/confirmInvitationToConnect/john/root

eXo authentication for generated doc on REST API

ignoreInvitationToConnect

public javax.ws.rs.core.Response ignoreInvitationToConnect(String senderId,
                                                           String receiverId)
                                                    throws Exception

Processes the "Deny the invitation to connect" action between 2 users, then redirects to the receiver's page of received invitations. A message informing that the receiver ignored the sender's invitation will be displayed.

Parameters:

senderId - The sender's remote Id.

receiverId - The receiver's remote Id.

Returns:

Redirects to the receiver's page of received invitations and displays a message.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/ignoreInvitationToConnect/john/root

eXo authentication for generated doc on REST API

acceptInvitationToJoinSpace

public javax.ws.rs.core.Response acceptInvitationToJoinSpace(String spaceId,
                                                             String userId)
                                                      throws Exception

Processes the "Accept the invitation to join a space" action and redirects to the space homepage.

Parameters:

userId - The invitee's remote Id.

spaceId - Id of the space.

Returns:

Redirects to the space's homepage.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/acceptInvitationToJoinSpace/e1cacf067f0001015ac312536462fc6b/john

eXo authentication for generated doc on REST API

ignoreInvitationToJoinSpace

public javax.ws.rs.core.Response ignoreInvitationToJoinSpace(String spaceId,
                                                             String userId)
                                                      throws Exception

Processes the "Deny the invitation to join a space" action, then redirects to the page of all spaces. A message informing that the invitee has denied to join the space will be displayed.

Parameters:

userId - The invitee's remote Id.

spaceId - Id of the space.

Returns:

Redirects to the page of all spaces and displays a message.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/ignoreInvitationToJoinSpace/e1cacf067f0001015ac312536462fc6b/john

eXo authentication for generated doc on REST API

validateRequestToJoinSpace

public javax.ws.rs.core.Response validateRequestToJoinSpace(String spaceId,
                                                            String userId)
                                                     throws Exception

Adds a member to a space, then redirects to the space's members page. A message informing the added user is already member of the space or not will be displayed. This action is only for the space manager.

Parameters:

userId - The remote Id of the user who requests for joining the space.

spaceId - Id of the space.

Returns:

Redirects to the space's members page and displays the message.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/validateRequestToJoinSpace/e1cacf067f0001015ac312536462fc6b/john

eXo authentication for generated doc on REST API

refuseRequestToJoinSpace

public javax.ws.rs.core.Response refuseRequestToJoinSpace(String spaceId,
                                                          String userId)
                                                   throws Exception

Refuses a user's request for joining a space, then redirects to the space's members page. This action is only for the space manager.

Parameters:

userId - The remote Id of the user who requests for joining the space.

spaceId - Id of the space.

Returns:

Redirects to the space's members page.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/refuseRequestToJoinSpace/e1cacf067f0001015ac312536462fc6b/john

eXo authentication for generated doc on REST API

redirectUrl

public javax.ws.rs.core.Response redirectUrl(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String type,
                                             String objectId)
                                      throws Exception

Redirects the current user to an associated page, such as user activity stream, portal homepage, space homepage and user profile.

Parameters:

type - Type of the redirected page.

objectId - Id of the associated type that can be activity Id, space Id, or user remote Id.

Returns:

Redirects to the associated page.

Throws:

Exception

eXo anchor for generated doc on REST API

GET: localhost:8080/rest/social/notifications/redirectUrl/view_full_activity/e1d2870c7f0001014e32114f6ff8a7ab

eXo authentication for generated doc on REST API

getSpaceService

public org.exoplatform.social.core.space.spi.SpaceService getSpaceService()

Gets a service which manages all things related to spaces.

Returns:

The SpaceService.

See Also:

SpaceService