org.apache.shindig.extras.as.opensocial.spi

Interface ActivityStreamService

All Known Implementing Classes:

ActivityStreamsJsonDbService

public interface ActivityStreamService

The ActivityService interface defines the service provider interface to retrieve activities from the underlying SNS.

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	createActivityEntry(UserId userId, GroupId groupId, String appId, Set<String> fields, ActivityEntry activity, SecurityToken token) Creates the passed in activity for the passed in user and group.
Future<Void>	deleteActivityEntries(UserId userId, GroupId groupId, String appId, Set<String> activityIds, SecurityToken token) Deletes the activity for the passed in user and group that corresponds to the activityId.
Future<RestfulCollection<ActivityEntry>>	getActivityEntries(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token) Returns a list of activities that correspond to the passed in users and group.
Future<RestfulCollection<ActivityEntry>>	getActivityEntries(UserId userId, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, Set<String> activityIds, SecurityToken token) Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.
Future<ActivityEntry>	getActivityEntry(UserId userId, GroupId groupId, String appId, Set<String> fields, String activityId, SecurityToken token) Returns an activity for the passed in user and group that corresponds to a single activityId.

Method Detail

getActivityEntries

Future<RestfulCollection<ActivityEntry>> getActivityEntries(Set<UserId> userIds,
                                                          GroupId groupId,
                                                          String appId,
                                                          Set<String> fields,
                                                          CollectionOptions options,
                                                          SecurityToken token)
                                                            throws ProtocolException

Returns a list of activities that correspond to the passed in users and group.

Parameters:

userIds - The set of ids of the people to fetch activities for.

groupId - Indicates whether to fetch activities for a group.

appId - The app id.

fields - The fields to return. Empty set implies all

options - The sorting/filtering/pagination options

token - A valid SecurityToken

Returns:

a response item with the list of activities.

Throws:

ProtocolException - if any.

getActivityEntries

Future<RestfulCollection<ActivityEntry>> getActivityEntries(UserId userId,
                                                          GroupId groupId,
                                                          String appId,
                                                          Set<String> fields,
                                                          CollectionOptions options,
                                                          Set<String> activityIds,
                                                          SecurityToken token)
                                                            throws ProtocolException

Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.

Parameters:

userId - The set of ids of the people to fetch activities for.

groupId - Indicates whether to fetch activities for a group.

appId - The app id.

fields - The fields to return. Empty set implies all

options - The sorting/filtering/pagination options

activityIds - The set of activity ids to fetch.

token - A valid SecurityToken

Returns:

a response item with the list of activities.

Throws:

ProtocolException - if any.

getActivityEntry

Future<ActivityEntry> getActivityEntry(UserId userId,
                                     GroupId groupId,
                                     String appId,
                                     Set<String> fields,
                                     String activityId,
                                     SecurityToken token)
                                       throws ProtocolException

Returns an activity for the passed in user and group that corresponds to a single activityId.

Parameters:

userId - The set of ids of the people to fetch activities for.

groupId - Indicates whether to fetch activities for a group.

appId - The app id.

fields - The fields to return. Empty set implies all

activityId - The activity id to fetch.

token - A valid SecurityToken

Returns:

a response item with the list of activities.

Throws:

ProtocolException - if any.

deleteActivityEntries

Future<Void> deleteActivityEntries(UserId userId,
                                 GroupId groupId,
                                 String appId,
                                 Set<String> activityIds,
                                 SecurityToken token)
                                   throws ProtocolException

Deletes the activity for the passed in user and group that corresponds to the activityId.

Parameters:

userId - The user.

groupId - The group.

appId - The app id.

activityIds - A list of activity ids to delete.

token - A valid SecurityToken.

Returns:

a response item containing any errors

Throws:

ProtocolException - if any.

createActivityEntry

Future<Void> createActivityEntry(UserId userId,
                               GroupId groupId,
                               String appId,
                               Set<String> fields,
                               ActivityEntry activity,
                               SecurityToken token)
                                 throws ProtocolException

Creates the passed in activity for the passed in user and group. Once createActivity is called, getActivities will be able to return the Activity.

Parameters:

userId - The id of the person to create the activity for.

groupId - The group.

appId - The app id.

fields - The fields to return.

activity - The activity to create.

token - A valid SecurityToken

Returns:

a response item containing any errors

Throws:

ProtocolException - if any.