Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
Copyright (c) 2015, Alessandro Pieri
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/
package io.getstream.client.repo;
import io.getstream.client.exception.StreamClientException;
import io.getstream.client.model.activities.AggregatedActivity;
import io.getstream.client.model.activities.BaseActivity;
import io.getstream.client.model.activities.NotificationActivity;
import io.getstream.client.model.beans.FeedFollow;
import io.getstream.client.model.beans.FollowMany;
import io.getstream.client.model.beans.MarkedActivity;
import io.getstream.client.model.beans.StreamActivitiesResponse;
import io.getstream.client.model.beans.StreamResponse;
import io.getstream.client.model.feeds.BaseFeed;
import io.getstream.client.model.filters.FeedFilter;
import java.io.IOException;
import java.util.List;
/**
* Provide low-level access to the GetStream.io REST API.
*/
public interface StreamRepository {
/**
* Delete activity by activity id.
*
* @param feed Feed that contains the activity to be deleted.
* @param activityId Activity-id to be deleted.
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
void deleteActivityById(BaseFeed feed, String activityId) throws IOException, StreamClientException;
/**
* Delete activity by foreign id.
*
* @param feed Feed that contains the activity to be deleted.
* @param foreignId foreignId to be deleted.
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exceptions
*/
void deleteActivityByForeignId(BaseFeed feed, String foreignId) throws IOException, StreamClientException;
/**
* Generate a JWT token to perform readonly operations.
* @param feed Input feed
* @return JWT token
*/
String getReadOnlyToken(BaseFeed feed);
/**
* Follow a feed.
*
* @param feed Feed that wants to follow a target feed.
* @param targetFeedId Feed to follow.
* @param activityCopyLimit How many activities should be copied from the target feed
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
void follow(BaseFeed feed, String targetFeedId, int activityCopyLimit) throws StreamClientException, IOException;
/**
* Follow many feed in one shot.
*
* @param feed Feed that wants to follow a target feed.
* @param followManyInput A {@link FollowMany} object which contains a list of sources and targets
* @param activityCopyLimit Number of activities to copy from a source feed to the destination feed
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
void followMany(BaseFeed feed, FollowMany followManyInput, int activityCopyLimit) throws StreamClientException, IOException;
/**
* Unfollow a feed.
*
* @param feed Source feed
* @param targetFeedId Feed to unfollow.
* @param keepHistory Whether the activities from the unfollowed feed should be removed
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
void unfollow(BaseFeed feed, String targetFeedId, boolean keepHistory) throws StreamClientException, IOException;
/**
* List the feeds which the given feed is following.
*
* @param feed Source feed
* @param filter Filter out the following list. Limited to 25 items by default.
* @return List of following
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
List getFollowing(BaseFeed feed, FeedFilter filter) throws StreamClientException, IOException;
/**
* Lists the followers for the given feed.
*
* @param feed Source feed
* @param filter Filter out the followers list. Limited to 25 items by default.
* @return List of followers
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
List getFollowers(BaseFeed feed, FeedFilter filter) throws StreamClientException, IOException;
/**
* Lists the activities in the given feed.
*
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param filter Filter out the activities. Limited to 25 items by default.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return List of activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamResponse getActivities(BaseFeed feed, Class type, FeedFilter filter) throws IOException, StreamClientException;
/**
* Add a new activity to the given feed.
*
* @param feed Feed which the activities belong to
* @param activity Activity to add.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return Activity as returned by the Stream server
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
T addActivity(BaseFeed feed, T activity) throws StreamClientException, IOException;
/**
* Add a new list of activities to the given feed.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param activities List of activities to add @return Activity as returned by the Stream server
* @return List of just sent activities
* @throws StreamClientException in case of functional or server-side exception
* @throws IOException in case of network/socket exceptions
*/
StreamActivitiesResponse addActivities(BaseFeed feed, Class type, List activities) throws StreamClientException, IOException;
/**
* Update activities (foreignId and time are mandatory fields).
* Please refer to GetStream.io/docs for more info.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param activities List of activities to update @return Operation response
* @return List of just sent activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamActivitiesResponse updateActivities(BaseFeed feed, Class type, List activities) throws IOException, StreamClientException;
/**
* Add a new activity of type {@link T} to multiple feeds.
*
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @param targetIds Destination feeds. A target id is defined as $feedSlug:$feedId.
* @param activity Activity to add.
* @return Response activity of type {@link T} coming from the server.
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
T addActivityToMany(List targetIds, T activity) throws StreamClientException, IOException;
/**
* List aggregated activities.
*
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param filter Filter out the activities. Limited to 25 items by default.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return List of aggregated activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamResponse> getAggregatedActivities(BaseFeed feed, Class type, FeedFilter filter) throws IOException, StreamClientException;
/**
* List notification activities.
*
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param filter Filter out the activities.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return List of notification activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamResponse> getNotificationActivities(BaseFeed feed, Class type, FeedFilter filter) throws IOException, StreamClientException;
/**
* List notifications marking the activities as read and/or as seen.
*
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param filter Filter the activities.
* @param markAsRead Mark all the activities as read.
* @param markAsSeen Mark all the activities as seen.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return List of notification activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamResponse> getNotificationActivities(BaseFeed feed, Class type, FeedFilter filter, boolean markAsRead, boolean 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 {@link MarkedActivity} builder.
*
* @param feed Feed which the activities belong to
* @param type Type of the activity. Must be a subtype of {@link BaseActivity}
* @param filter Filter the activities.
* @param markAsRead List of activities to be marked as read.
* @param markAsSeen List of activities to be marked as seen.
* @param Subtype of {@link BaseActivity} representing the activity type to handle.
* @return List of notification activities
* @throws IOException in case of network/socket exceptions
* @throws StreamClientException in case of functional or server-side exception
*/
StreamResponse> getNotificationActivities(BaseFeed feed, Class type, FeedFilter filter, MarkedActivity markAsRead, MarkedActivity markAsSeen) throws IOException, StreamClientException;
/**
* Get the token for the given feed.
* @param feed Feed
* @return A token string
*/
String getToken(BaseFeed feed);
/**
* Send the shutdown signal to the client.
*
* @throws IOException in case of network/socket exceptions
*/
void shutdown() throws IOException;
}
