io.getstream.client.repo

Interface StreamPersonalizedRepository

public interface StreamPersonalizedRepository

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

Method Summary

Modifier and Type	Method and Description
MetaResponse	addMeta(PersonalizedFeed feed, Serializable metaPayload) "Certain objects such as user profiles, product details etc.
<T extends PersonalizedActivity> List<T>	get(PersonalizedFeed feed, Class<T> type, FeedFilter filter) Read a personalized feed.
<T extends Serializable> List<T>	getInterest(PersonalizedFeed feed, Class<T> type) Read the taste/ endpoint.

Method Detail

get

<T extends PersonalizedActivity> List<T> get(PersonalizedFeed feed,
                                             Class<T> type,
                                             FeedFilter filter)
                                      throws IOException,
                                             StreamClientException

Read a personalized feed. The response is deserialized by using Jackson, therefore Jackson's annotations and custom deserializers are honored.

Type Parameters:

T - Type of the class to use to perform deserialization.

Parameters:

feed - the feed you want to read from

type - Since the personalized feed can be heavily customized, we need to know which class to use to perform deserialized.

filter - Filter out the results.

Returns:

Personalized feed

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

addMeta

MetaResponse addMeta(PersonalizedFeed feed,
                     Serializable metaPayload)
              throws IOException,
                     StreamClientException

"Certain objects such as user profiles, product details etc. aren't part of the feeds. They can however be useful for personalization." Use this method to sync this data to Stream. The meta payload is serialized by using Jackson, therefore Jackson's annotations and custom serializers are honored.

Parameters:

feed - The feed you want to enrich with meta-data

metaPayload - The meta object can be customized by the customer. The method accepts any Serializable object.

Returns:

Short response about the call.

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception

getInterest

<T extends Serializable> List<T> getInterest(PersonalizedFeed feed,
                                             Class<T> type)
                                      throws IOException,
                                             StreamClientException

Read the taste/ endpoint. The response is deserialized by using Jackson, therefore Jackson's annotations and custom deserializers are honored. This endpoint is not provided by default and is activated to selected customer.

Type Parameters:

T - Type of the class to use to perform deserialization.

Parameters:

feed - the feed you want to read from

type - Since the personalized feed can be heavily customized, we need to know which class to use to perform deserialized.

Returns:

Taste results

Throws:

IOException - in case of network/socket exceptions

StreamClientException - in case of functional or server-side exception