io.getstream.client.model.feeds

Interface Feed

All Known Implementing Classes:

BaseFeed

public interface Feed

Feed class. It exposes operations to perform against a feed.

Method Summary

Modifier and Type	Method and Description
void	deleteActivity(String activityId) Removes an activity from the feed.
void	deleteActivityByForeignId(String foreignId) Removes an activity from the feed.
void	follow(String feedSlug, String userId) Follows the given target feed.
void	follow(String feedSlug, String userId, int activityCopyLimit) Follows the given target feed.
void	followMany(FollowMany follows) Follow many feed in one shot.
void	followMany(FollowMany follows, int activityCopyLimit) Follow many feed in one shot.
List<FeedFollow>	getFollowers() Lists the followers of the feed.
List<FeedFollow>	getFollowers(FeedFilter filter) Lists the followers of the feed using the given filter.
List<FeedFollow>	getFollowing() List the feeds which this feed is following.
List<FeedFollow>	getFollowing(FeedFilter filter) List the feeds which this feed is following using the give filter.
String	getId() Get the feed ID.
String	getReadOnlyToken() Generate a JWT token to perform readonly operations
String	getToken() Get the feed token.
<T extends BaseActivity> AggregatedActivityServiceImpl<T>	newAggregatedActivityService(Class<T> clazz) Get mediator service to handle aggregated activities.
<T extends BaseActivity> FlatActivityServiceImpl<T>	newFlatActivityService(Class<T> clazz) Get mediator service to handle aggregated activities.
<T extends BaseActivity> NotificationActivityServiceImpl<T>	newNotificationActivityService(Class<T> clazz) Get mediator service to handle aggregated activities.
<T extends BaseActivity> UserActivityServiceImpl<T>	newUserActivityService(Class<T> clazz) Get mediator service to handle aggregated activities.
void	unfollow(String feedSlug, String userId) Unfollow the given target feed.
void	unfollow(String feedSlug, String userId, boolean keepHistory) Unfollow the given target feed.

Method Detail

getId

String getId()

Get the feed ID.

Returns:

Feed ID

getToken

String getToken()

Get the feed token.

Returns:

Token

getReadOnlyToken

String getReadOnlyToken()

Generate a JWT token to perform readonly operations

Returns:

Token

follow

void follow(String feedSlug,
            String userId)
     throws IOException,
            StreamClientException

Follows the given target feed.

Parameters:

feedSlug - the slug of the target feed.

userId - user id

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

follow

void follow(String feedSlug,
            String userId,
            int activityCopyLimit)
     throws IOException,
            StreamClientException

Follows the given target feed.

Parameters:

feedSlug - the slug of the target feed.

userId - user id

activityCopyLimit - How many activities should be copied from the target feed

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

followMany

void followMany(FollowMany follows,
                int activityCopyLimit)
         throws IOException,
                StreamClientException

Follow many feed in one shot.

Parameters:

follows - A FollowMany object which contains a list of sources and targets

activityCopyLimit - the maximum number of activities from a source feed that must be copied to a target feed

Throws:

StreamClientException - in case of functional or server-side exception

IOException - in case of network/socket exceptions

followMany

void followMany(FollowMany follows)
         throws IOException,
                StreamClientException

Follow many feed in one shot. Default activity copy limit is set to 300. Maximum 300 activities from a given source feed will be copied to the target feed.

Parameters:

follows - A FollowMany object which contains a list of sources and targets

Throws:

StreamClientException - in case of functional or server-side exception

IOException - in case of network/socket exceptions

unfollow

void unfollow(String feedSlug,
              String userId)
       throws IOException,
              StreamClientException

Unfollow the given target feed.

Parameters:

feedSlug - the slug of the target feed.

userId - user id

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

unfollow

void unfollow(String feedSlug,
              String userId,
              boolean keepHistory)
       throws IOException,
              StreamClientException

Unfollow the given target feed.

Parameters:

feedSlug - the slug of the target feed.

userId - user id

keepHistory - Whether the activities from the unfollowed feed should be removed

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowers

List<FeedFollow> getFollowers()
                       throws IOException,
                              StreamClientException

Lists the followers of the feed.

Returns:

List of followers

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowers

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

Lists the followers of the feed using the given filter.

Parameters:

filter - Filter out the followers.

Returns:

List of followers

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowing

List<FeedFollow> getFollowing()
                       throws IOException,
                              StreamClientException

List the feeds which this feed is following.

Returns:

List of following

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowing

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

List the feeds which this feed is following using the give filter.

Parameters:

filter - Filter out the list of following feeds.

Returns:

List of following

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

deleteActivity

void deleteActivity(String activityId)
             throws IOException,
                    StreamClientException

Removes an activity from the feed.

Parameters:

activityId - the activity id to remove from this feed.

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

deleteActivityByForeignId

void deleteActivityByForeignId(String foreignId)
                        throws IOException,
                               StreamClientException

Removes an activity from the feed.

Parameters:

foreignId - the activity id to remove from this feed.

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

newFlatActivityService

<T extends BaseActivity> FlatActivityServiceImpl<T> newFlatActivityService(Class<T> clazz)

Get mediator service to handle aggregated activities.

Type Parameters:

T - Subtype of BaseActivity representing the activity type to handle.

Parameters:

clazz - Subtype of BaseActivity representing the activity type to handle.

Returns:

New activity service

newAggregatedActivityService

<T extends BaseActivity> AggregatedActivityServiceImpl<T> newAggregatedActivityService(Class<T> clazz)

Get mediator service to handle aggregated activities.

Type Parameters:

T - Subtype of BaseActivity representing the activity type to handle.

Parameters:

clazz - Subtype of BaseActivity representing the activity type to handle.

Returns:

New aggregated activity service

newUserActivityService

<T extends BaseActivity> UserActivityServiceImpl<T> newUserActivityService(Class<T> clazz)

Get mediator service to handle aggregated activities.

Type Parameters:

T - Subtype of BaseActivity representing the activity type to handle.

Parameters:

clazz - Subtype of BaseActivity representing the activity type to handle.

Returns:

New user activity service

newNotificationActivityService

<T extends BaseActivity> NotificationActivityServiceImpl<T> newNotificationActivityService(Class<T> clazz)

Get mediator service to handle aggregated activities.

Type Parameters:

T - Subtype of BaseActivity representing the activity type to handle.

Parameters:

clazz - Subtype of BaseActivity representing the activity type to handle.

Returns:

New notification activity service