com.adobe.cq.social.activitystreams.api

Interface SocialActivityManager

All Superinterfaces:

ActivityManager

All Known Subinterfaces:

PostFilterSocialActivityManager

public interface SocialActivityManager
extends ActivityManager

The activity manager is used as entry point to read, create and write activities and activity streams.

Method Summary

Modifier and Type	Method and Description
void	deleteActivity(Activity activity) Delete an activity from a activity stream.
SocialActivityStream	getSocialStream(Resource streamResource) Returns the activity stream for the given resource.
SocialActivityStream	getSocialStream(ResourceResolver resolver, Authorizable auth, java.lang.String streamName, boolean create) Gets the distinct activity stream for the given authorizable.
SocialActivityStream	getSocialStream(Resource containerResource, java.lang.String name, boolean create) Returns the activity stream for the given container resource, e.g.

Methods inherited from interface com.adobe.granite.activitystreams.ActivityManager

getActivities, getActivities, getActivity, getFollowers, getFollowers, getGroupStream, getStream, getStream, getStream, getTopicStream, getUserStream, getUserStream, getUserStream, listStreams, listStreams, newActivity, newActivity, newActivityObject, newMediaLink

Method Detail

getSocialStream

SocialActivityStream getSocialStream(Resource streamResource)
                              throws ActivityException

Returns the activity stream for the given resource.

Parameters:

streamResource - the stream resource

Returns:

the stream

Throws:

ActivityException - if an error occurs

getSocialStream

SocialActivityStream getSocialStream(ResourceResolver resolver,
                                     Authorizable auth,
                                     java.lang.String streamName,
                                     boolean create)
                              throws ActivityException

Gets the distinct activity stream for the given authorizable.

Parameters:

resolver - resource resolver to resolve the path

auth - the jackrabbit authorizable

streamName - the name of the stream or null to use the default stream

create - create stream if it doesn't exist

Returns:

the activity stream or null if the user or his stream does not exist.

Throws:

ActivityException - if an error occurs

getSocialStream

SocialActivityStream getSocialStream(Resource containerResource,
                                     java.lang.String name,
                                     boolean create)
                              throws ActivityException

Returns the activity stream for the given container resource, e.g. user, group, document. If the stream does not exist and create is true a new stream is created.

Parameters:

containerResource - the container resource

name - the stream name

create - create stream if it doesn't exist

Returns:

the stream or null if no such stream exists

Throws:

ActivityException - if an error occurs

deleteActivity

void deleteActivity(Activity activity)
             throws ActivityException

Delete an activity from a activity stream.

Parameters:

activity - The activity to delete from the stream

Throws:

ActivityException - When error occurs