org.exoplatform.social.service.rest.api

Class ActivityResources

java.lang.Object

org.exoplatform.social.service.rest.api.ActivityResources

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

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

Activity Resources end point.

eXo anchor for generated doc on REST API

ActivityResources

Constructor Summary

Constructors

Constructor and Description
ActivityResources()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createCommentActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format, CommentRestIn comment) Posts a new comment on an existing activity.
javax.ws.rs.core.Response	createLikeActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Allows an authenticated identity to do the "like" action on an existing activity.
javax.ws.rs.core.Response	createNewActivity(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String format, String identityIdStream, ActivityRestIn newActivity) Creates an activity to an identity's activity stream.
javax.ws.rs.core.Response	deleteCommentById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format, String commentId) Deletes an existing comment by its Id.
javax.ws.rs.core.Response	deleteExistingActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Deletes an existing activity by its Id using the DELETE method.
javax.ws.rs.core.Response	deleteLikeActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Allows an identity to remove his "like" action on an activity.
javax.ws.rs.core.Response	getActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format, String showPosterIdentity, int numberOfComments, String showActivityStream, int numberOfLikes) Gets an activity object from a specified activity Id.
javax.ws.rs.core.Response	getCommentsByActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Gets the comments on an activity.
javax.ws.rs.core.Response	getLikesFromIdentityId(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Gets all the identities who like an existing activity.
javax.ws.rs.core.Response	postDeleteCommentById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format, String commentId) Deletes an existing comment by its Id using the POST method.
javax.ws.rs.core.Response	postDeleteLikeActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Allows an identity to remove his "like" action on an activity.
javax.ws.rs.core.Response	postToDeleteActivityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String activityId, String format) Deletes an existing activity by its Id using the POST method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityResources

public ActivityResources()

Method Detail

getActivityById

public javax.ws.rs.core.Response getActivityById(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String portalContainerName,
                                                 String activityId,
                                                 String format,
                                                 String showPosterIdentity,
                                                 int numberOfComments,
                                                 String showActivityStream,
                                                 int numberOfLikes)

Gets an activity object from a specified activity Id.

Parameters:

uriInfo - The uri request info.

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

showPosterIdentity - When this parameter is set to true, t or 1, the returned activity will provide more information for the user who posted this activity.

numberOfComments - Specify the number of comments to be displayed along with this activity. By default, _number\_of\_comments=0_. If _number_of_comments_ is a positive number, this number is considered as a limit number that must be equal or less than 100. If the actual number of comments is less than the provided positive number, the number of actual comments must be returned. If the total number of comments is more than 100, it is recommended to use _activity/\:id/comments.format_ instead.

numberOfLikes - Specify the number of latest detailed likes to be returned along with this activity. By default, _number\_of\_likes=0_. If _number\_of\_likes_ is a positive number, this number is considered as a limit number that must be equal or less than 100. If the total number of likes is less than the provided positive number, the number of actual likes must be returned. If the total number of likes is more than 100, it is recommended to use _activity/\:activityId/likes.format_ instead.

showActivityStream - When this parameter is set to true, t or 1, the returned activity will provide more information for the activity stream that this activity belongs to.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.getActivityById

eXo anchor for generated doc on REST API

GET http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e6f7g8h9i.json

eXo response for generated doc on REST API

{ "id": "1a2b3c4d5e6f7g8h9j", "title": "Hello World!!!", "appId": "", "type": "exosocial:core", "postedTime": 123456789, //timestamp "createdAt": "Fri Jun 17 06:42:26 +0000 2011", //The Date follows ISO 8601 "priority": 0.5, //between 0.0 and 1.0, higher value = higher priority. "templateParams": {}, "titleId": "", "identityId": "123456789abcdefghi", //the identity id of the user who created this activity "liked": true, //is liked (favorites) by this authenticated identity "likedByIdentities": ["identityId1", "identityId2"], "posterIdentity": {}, //optional "comments": [{}, {}, {}], //optional "totalNumberOfComments": 1234, "activityStream": { "type": "user", // or "space" "prettyId": "root", // or space_abcde "faviconURL": "http://demo3.exoplatform.org/favicons/exo-default.jpg", "title": "Activity Stream of Root Root", "permaLink": "http://localhost:8080/profile/root" } //optional }

eXo authentication for generated doc on REST API

createNewActivity

public javax.ws.rs.core.Response createNewActivity(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   String portalContainerName,
                                                   String format,
                                                   String identityIdStream,
                                                   ActivityRestIn newActivity)

Creates an activity to an identity's activity stream. If no _identity\_id_ is specified, the activity will be created to the authenticated identity's activity stream.

Parameters:

uriInfo - the uri request info

portalContainerName - The associated portal container name.

format - The expected returned format.

identityIdStream - The optional identity stream to post this new activity to.

newActivity - A new activity instance.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.createNewActivity

eXo anchor for generated doc on REST API

http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity.json BODY: {"title": "Hello World!!!"}

eXo response for generated doc on REST API

{ "id": "1a2b3c4d5e6f7g8h9j", "title": "Hello World!!!", "appId": "", "type": "exosocial:core", "postedTime": 123456789, //timestamp "createdAt": "Fri Jun 17 06:42:26 +0000 2011", "priority": 0.5, //between 0.0 and 1.0, higher value = higher priority. "templateParams": {}, "titleId": "", "identityId": "123456789abcdefghi" //the identity id of the user who created this activity }

eXo authentication for generated doc on REST API

deleteExistingActivityById

public javax.ws.rs.core.Response deleteExistingActivityById(@Context
                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                            String portalContainerName,
                                                            String activityId,
                                                            String format)

Deletes an existing activity by its Id using the DELETE method. The deleted activity information will be returned in the JSON format.

Parameters:

uriInfo - the uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.deleteExistingActivityById

eXo anchor for generated doc on REST API

DELETE: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e6f7g8h9i.json

eXo response for generated doc on REST API

{ "id": "1a2b3c4d5e6f7g8h9j", "title": "Hello World!!!", "appId": "", "type": "exosocial:core", "postedTime": 123456789, //timestamp "createdAt": "Fri Jun 17 06:42:26 +0000 2011", //The Date follows ISO 8601 "priority": 0.5, //between 0.0 and 1.0, higher value = higher priority. "templateParams": {}, "titleId": "", "identityId": "123456789abcdefghi", //the identity id of the user who created this activity "liked": true, //is liked (favorites) by this authenticated identity "likedByIdentities": ["identityId1", "identityId2"], "posterIdentity": {}, //optional "comments": [{}, {}, {}], //optional "totalNumberOfComments": 1234, //if comments is required, the total number of comments "activityStream": { "type": "user", // or "space" "prettyId": "root", // or space_abcde "faviconURL": "http://demo3.exoplatform.org/favicons/exo-default.jpg", "title": "Activity Stream of Root Root", "permaLink": "http://localhost:8080/profile/root" } //optional }

eXo authentication for generated doc on REST API

postToDeleteActivityById

public javax.ws.rs.core.Response postToDeleteActivityById(@Context
                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                          String portalContainerName,
                                                          String activityId,
                                                          String format)

Deletes an existing activity by its Id using the POST method. The deleted activity information will be returned in the JSON format. It is recommended to use the DELETE method, except the case that clients cannot make request via this method.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.postToDeleteActivityById

eXo anchor for generated doc on REST API

POST: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/destroy/1a2b3c4d5e6f7g8h9i.json

eXo response for generated doc on REST API

{ "id": "1a2b3c4d5e6f7g8h9j", "title": "Hello World!!!", "appId": "", "type": "exosocial:core", "postedTime": 123456789, //timestamp "createdAt": "Fri Jun 17 06:42:26 +0000 2011", //The Date follows ISO 8601 "priority": 0.5, //between 0.0 and 1.0, higher value = higher priority. "templateParams": {}, "titleId": "", "identityId": "123456789abcdefghi", //the identity id of the user who created this activity "liked": true, //is liked (favorites) by this authenticated identity "likedByIdentities": ["identityId1", "identityId2"], "posterIdentity": {}, //optional "comments": [{}, {}, {}], //optional "totalNumberOfComments": 1234, //if comments is required, the total number of comments "activityStream": { "type": "user", // or "space" "prettyId": "root", // or space_abcde "faviconURL": "http://demo3.exoplatform.org/favicons/exo-default.jpg", "title": "Activity Stream of Root Root", "permaLink": "http://localhost:8080/profile/root" } //optional }

eXo authentication for generated doc on REST API

getCommentsByActivityById

public javax.ws.rs.core.Response getCommentsByActivityById(@Context
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String portalContainerName,
                                                           String activityId,
                                                           String format)

Gets the comments on an activity.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.getCommentsByActivityById

eXo anchor for generated doc on REST API

GET: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/comments.json

eXo response for generated doc on REST API

{ total: 10, comments: [ { "id": "123456" "identityId": "12345abcde", "text": "Comment there!", "postedTime": 123456789, "createdAt": "Fri Jun 17 06:42:26 +0000 2011" }, { "id" : "234567" "identityId": "12345abcde", "text": "Comment there 2!", "postedTime": 123456789, "createdAt": "Fri Jun 17 06:42:26 +0000 2011" } ] }

eXo authentication for generated doc on REST API

createCommentActivityById

public javax.ws.rs.core.Response createCommentActivityById(@Context
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String portalContainerName,
                                                           String activityId,
                                                           String format,
                                                           CommentRestIn comment)

Posts a new comment on an existing activity. The poster of this comment is an authenticated identity.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.createCommentActivityById

eXo anchor for generated doc on REST API

POST: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/comment.json BODY: {"text": "My comment here!!!"}

eXo response for generated doc on REST API

{ "id": "123456" "identityId": "12345abcde", "text": "My comment here!!!", "postedTime": 123456789, "createdAt": "Fri Jun 17 06:42:26 +0000 2011" }

eXo authentication for generated doc on REST API

deleteCommentById

public javax.ws.rs.core.Response deleteCommentById(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   String portalContainerName,
                                                   String activityId,
                                                   String format,
                                                   String commentId)

Deletes an existing comment by its Id.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

commentId - The specified comment Id.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.deleteCommentById

eXo anchor for generated doc on REST API

DELETE: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/comment/123456.json

eXo response for generated doc on REST API

{ "id": "123456" "identityId": "12345abcde", "text": "My comment here!!!", "postedTime": 123456789, "createdAt": "Fri Jun 17 06:42:26 +0000 2011" }

eXo authentication for generated doc on REST API

postDeleteCommentById

public javax.ws.rs.core.Response postDeleteCommentById(@Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       String portalContainerName,
                                                       String activityId,
                                                       String format,
                                                       String commentId)

Deletes an existing comment by its Id using the POST method. The deleted activity information will be returned in the JSON format. It is recommended to use the POST method, except the case that clients cannot make request via this method.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

commentId - The specified comment Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.postDeleteCommentById

eXo anchor for generated doc on REST API

POST: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/comment/destroy/123456.json

eXo response for generated doc on REST API

{ "id": "123456" "identityId": "12345abcde", "text": "My comment here!!!", "postedTime": 123456789, "createdAt": "Fri Jun 17 06:42:26 +0000 2011" }

eXo authentication for generated doc on REST API

getLikesFromIdentityId

public javax.ws.rs.core.Response getLikesFromIdentityId(@Context
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String portalContainerName,
                                                        String activityId,
                                                        String format)

Gets all the identities who like an existing activity.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.getLikesFromIdentityId

eXo anchor for generated doc on REST API

GET: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/likes.json

eXo response for generated doc on REST API

{ totalNumberOfLikes: 2, likesByIdentities: [ { "id":1234567, "providerId":"organization", "remoteId":"demo", "profile": { "fullName":"Demo GTN", "avatarUrl":"http://localhost:8080/profile/u/demo/avatar.jpg?u=12345" } }, { "id":23456, "providerId":"organization", "remoteId":"root", "profile": { "fullName":"Root GTN", "avatarUrl":"http://localhost:8080/profile/u/root/avatar.jpg?u=12345" } }, ] }

eXo authentication for generated doc on REST API

createLikeActivityById

public javax.ws.rs.core.Response createLikeActivityById(@Context
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String portalContainerName,
                                                        String activityId,
                                                        String format)

Allows an authenticated identity to do the "like" action on an existing activity.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.createLikeActivityById

eXo anchor for generated doc on REST API

POST: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/like.json

eXo response for generated doc on REST API

{ "liked": true }

eXo authentication for generated doc on REST API

deleteLikeActivityById

public javax.ws.rs.core.Response deleteLikeActivityById(@Context
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String portalContainerName,
                                                        String activityId,
                                                        String format)

Allows an identity to remove his "like" action on an activity.

Parameters:

uriInfo - The uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.deleteLikeActivityById

eXo anchor for generated doc on REST API

DELETE: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/like.json

eXo response for generated doc on REST API

{ "liked": false }

eXo authentication for generated doc on REST API

postDeleteLikeActivityById

public javax.ws.rs.core.Response postDeleteLikeActivityById(@Context
                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                            String portalContainerName,
                                                            String activityId,
                                                            String format)

Allows an identity to remove his "like" action on an activity. It is recommended to use the DELETE method, except the case that clients cannot make request via this method.

Parameters:

uriInfo - the uri request uri

portalContainerName - The associated portal container name.

activityId - The specified activity Id.

format - The expected returned format.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

ActivityResource.postDeleteLikeActivityById

eXo anchor for generated doc on REST API

POST: http://localhost:8080/rest/private/api/social/v1-alpha3/portal/activity/1a2b3c4d5e/like/destroy.json

eXo response for generated doc on REST API

{ "liked": false }

eXo authentication for generated doc on REST API