io.getstream.client.repo

Interface StreamRepository

public interface StreamRepository

Provide low-level access to the GetStream.io REST API.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends BaseActivity> T	addActivity(BaseFeed feed, T activity) Add a new activity to the given feed.
void	deleteActivityByForeignId(BaseFeed feed, String foreignId) Delete activity by foreign id.
void	deleteActivityById(BaseFeed feed, String activityId) Delete activity by activity id.
void	follow(BaseFeed feed, String targetFeedId) Follow a feed.
<T extends BaseActivity> StreamResponse<T>	getActivities(BaseFeed feed, Class<T> type, FeedFilter filter) Lists the activities in the given feed.
<T extends BaseActivity> StreamResponse<AggregatedActivity<T>>	getAggregatedActivities(BaseFeed feed, Class<T> type, FeedFilter filter) List aggregated activities.
List<FeedFollow>	getFollowers(BaseFeed feed, FeedFilter filter) Lists the followers for the given feed.
List<FeedFollow>	getFollowing(BaseFeed feed, FeedFilter filter) List the feeds which the given feed is following.
<T extends BaseActivity> StreamResponse<NotificationActivity<T>>	getNotificationActivities(BaseFeed feed, Class<T> type, FeedFilter filter) List notification activities.
<T extends BaseActivity> StreamResponse<NotificationActivity<T>>	getNotificationActivities(BaseFeed feed, Class<T> type, FeedFilter filter, boolean markAsRead, boolean markAsSeen) List notifications marking the activities as read and/or as seen.
<T extends BaseActivity> StreamResponse<NotificationActivity<T>>	getNotificationActivities(BaseFeed feed, Class<T> type, FeedFilter filter, MarkedActivity markAsRead, MarkedActivity markAsSeen) List notifications marking some of them as read and/or as seen.
String	getToken(BaseFeed feed)
void	shutdown() Send the shutdown signal to the client.
void	unfollow(BaseFeed feed, String targetFeedId) Unfollow a feed.

Method Detail

deleteActivityById

void deleteActivityById(BaseFeed feed,
                      String activityId)
                        throws IOException,
                               StreamClientException

Delete activity by activity id.

Parameters:

feed - Feed that contains the activity to be deleted.

activityId - Activity-id to be deleted.

Throws:

IOException

StreamClientException

deleteActivityByForeignId

void deleteActivityByForeignId(BaseFeed feed,
                             String foreignId)
                               throws IOException,
                                      StreamClientException

Delete activity by foreign id.

Parameters:

feed - Feed that contains the activity to be deleted.

foreignId - foreignId to be deleted.

Throws:

IOException

StreamClientException

follow

void follow(BaseFeed feed,
          String targetFeedId)
            throws StreamClientException,
                   IOException

Follow a feed.

Parameters:

feed - Feed that wants to follow a target feed.

targetFeedId - Feed to follow.

Throws:

StreamClientException

IOException

unfollow

void unfollow(BaseFeed feed,
            String targetFeedId)
              throws StreamClientException,
                     IOException

Unfollow a feed.

Parameters:

feed -

targetFeedId - Feed to unfollow.

Throws:

StreamClientException

IOException

getFollowing

List<FeedFollow> getFollowing(BaseFeed feed,
                            FeedFilter filter)
                              throws StreamClientException,
                                     IOException

List the feeds which the given feed is following.

Parameters:

feed -

filter - Filter out the following list. Limited to 25 items by default.

Returns:

Throws:

StreamClientException

IOException

getFollowers

List<FeedFollow> getFollowers(BaseFeed feed,
                            FeedFilter filter)
                              throws StreamClientException,
                                     IOException

Lists the followers for the given feed.

Parameters:

feed -

filter - Filter out the followers list. Limited to 25 items by default.

Returns:

Throws:

StreamClientException

IOException

getActivities

<T extends BaseActivity> StreamResponse<T> getActivities(BaseFeed feed,
                                                       Class<T> type,
                                                       FeedFilter filter)
                                                     throws IOException,
                                                            StreamClientException

Lists the activities in the given feed.

Type Parameters:

T -

Parameters:

feed - Feed which the activities belong to

type - Type of the activity. Must be a subtype of BaseActivity

filter - Filter out the activities. Limited to 25 items by default.

Returns:

Throws:

IOException

StreamClientException

addActivity

<T extends BaseActivity> T addActivity(BaseFeed feed,
                                     T activity)
                                   throws StreamClientException,
                                          IOException

Add a new activity to the given feed.

Type Parameters:

T -

Parameters:

feed - Feed which the activities belong to

activity - Activity to add.

Returns:

Throws:

StreamClientException

IOException

getAggregatedActivities

<T extends BaseActivity> StreamResponse<AggregatedActivity<T>> getAggregatedActivities(BaseFeed feed,
                                                                                     Class<T> type,
                                                                                     FeedFilter filter)
                                                                                   throws IOException,
                                                                                          StreamClientException

List aggregated activities.

Type Parameters:

T -

Parameters:

feed - Feed which the activities belong to

type - Type of the activity. Must be a subtype of BaseActivity

filter - Filter out the activities. Limited to 25 items by default.

Returns:

Throws:

IOException

StreamClientException

getNotificationActivities

<T extends BaseActivity> StreamResponse<NotificationActivity<T>> getNotificationActivities(BaseFeed feed,
                                                                                         Class<T> type,
                                                                                         FeedFilter filter)
                                                                                       throws IOException,
                                                                                              StreamClientException

List notification activities.

Type Parameters:

T -

Parameters:

feed -

type -

filter - Filter out the activities.

Returns:

Throws:

IOException

StreamClientException

getNotificationActivities

<T extends BaseActivity> StreamResponse<NotificationActivity<T>> getNotificationActivities(BaseFeed feed,
                                                                                         Class<T> type,
                                                                                         FeedFilter filter,
                                                                                         boolean markAsRead,
                                                                                         boolean markAsSeen)
                                                                                       throws IOException,
                                                                                              StreamClientException

List notifications marking the activities as read and/or as seen.

Type Parameters:

T -

Parameters:

feed -

type -

filter - Filter the activities.

markAsRead - Mark all the activities as read.

markAsSeen - Mark all the activities as seen.

Returns:

Throws:

IOException

StreamClientException

getNotificationActivities

<T extends BaseActivity> StreamResponse<NotificationActivity<T>> getNotificationActivities(BaseFeed feed,
                                                                                         Class<T> type,
                                                                                         FeedFilter filter,
                                                                                         MarkedActivity markAsRead,
                                                                                         MarkedActivity markAsSeen)
                                                                                       throws IOException,
                                                                                              StreamClientException

List notifications marking some of them as read and/or as seen. An immutable list of activities to be marked as read and/or as seen can be built using the MarkedActivity builder.

Type Parameters:

T -

Parameters:

feed -

type -

filter - Filter the activities.

markAsRead - List of activities to be marked as read.

markAsSeen - List of activities to be marked as seen.

Returns:

Throws:

IOException

StreamClientException

getToken

String getToken(BaseFeed feed)

shutdown

void shutdown()
              throws IOException

Send the shutdown signal to the client.

Throws:

IOException