io.getstream.client.model.feeds

Class BaseFeed

java.lang.Object

io.getstream.client.model.feeds.BaseFeed

All Implemented Interfaces:

Feed

public class BaseFeed
extends Object
implements Feed

Provide basic operation to perform against a feed.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	feedSlug
protected StreamRepository	streamRepository
protected String	userId

Constructor Summary

Constructors

Constructor and Description
BaseFeed(StreamRepository streamRepository, String feedSlug, String userId) Create a new feed using the given slug and user id.

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.
String	getFeedId()
String	getFeedSlug()
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.
String	getUserId()
<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.

Methods inherited from class java.lang.Object

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

Field Detail

streamRepository

protected final StreamRepository streamRepository

feedSlug

protected final String feedSlug

userId

protected final String userId

Constructor Detail

BaseFeed

public BaseFeed(StreamRepository streamRepository,
                String feedSlug,
                String userId)

Create a new feed using the given slug and user id.

Parameters:

streamRepository - Provide data repository to perform actual operation on a given feed. It must implement StreamRepository.

feedSlug - Feed slug

userId - User ID

Method Detail

getReadOnlyToken

public String getReadOnlyToken()

Description copied from interface: Feed

Generate a JWT token to perform readonly operations

Specified by:

getReadOnlyToken in interface Feed

Returns:

Token

follow

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

Description copied from interface: Feed

Follows the given target feed.

Specified by:

follow in interface 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

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

Description copied from interface: Feed

Follows the given target feed.

Specified by:

follow in interface 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

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

Description copied from interface: Feed

Follow many feed in one shot.

Specified by:

followMany in interface Feed

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:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

followMany

public void followMany(FollowMany follows)
                throws IOException,
                       StreamClientException

Description copied from interface: Feed

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.

Specified by:

followMany in interface Feed

Parameters:

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

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

unfollow

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

Description copied from interface: Feed

Unfollow the given target feed.

Specified by:

unfollow in interface 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

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

Description copied from interface: Feed

Unfollow the given target feed.

Specified by:

unfollow in interface 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

public List<FeedFollow> getFollowers()
                              throws IOException,
                                     StreamClientException

Description copied from interface: Feed

Lists the followers of the feed.

Specified by:

getFollowers in interface Feed

Returns:

List of followers

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowers

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

Description copied from interface: Feed

Lists the followers of the feed using the given filter.

Specified by:

getFollowers in interface Feed

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

public List<FeedFollow> getFollowing()
                              throws IOException,
                                     StreamClientException

Description copied from interface: Feed

List the feeds which this feed is following.

Specified by:

getFollowing in interface Feed

Returns:

List of following

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getFollowing

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

Description copied from interface: Feed

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

Specified by:

getFollowing in interface Feed

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

public void deleteActivity(String activityId)
                    throws IOException,
                           StreamClientException

Description copied from interface: Feed

Removes an activity from the feed.

Specified by:

deleteActivity in interface 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

public void deleteActivityByForeignId(String foreignId)
                               throws IOException,
                                      StreamClientException

Description copied from interface: Feed

Removes an activity from the feed.

Specified by:

deleteActivityByForeignId in interface 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

newAggregatedActivityService

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

Description copied from interface: Feed

Get mediator service to handle aggregated activities.

Specified by:

newAggregatedActivityService in interface Feed

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

newFlatActivityService

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

Description copied from interface: Feed

Get mediator service to handle aggregated activities.

Specified by:

newFlatActivityService in interface Feed

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

newUserActivityService

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

Description copied from interface: Feed

Get mediator service to handle aggregated activities.

Specified by:

newUserActivityService in interface Feed

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

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

Description copied from interface: Feed

Get mediator service to handle aggregated activities.

Specified by:

newNotificationActivityService in interface Feed

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

getFeedSlug

public String getFeedSlug()

getFeedId

public String getFeedId()

getUserId

public String getUserId()

getId

public String getId()

Description copied from interface: Feed

Get the feed ID.

Specified by:

getId in interface Feed

Returns:

Feed ID

getToken

public String getToken()

Description copied from interface: Feed

Get the feed token.

Specified by:

getToken in interface Feed

Returns:

Token