com.adobe.cq.social.subscriptions.api

Interface SubscriptionManager

public interface SubscriptionManager

Method Summary

Modifier and Type	Method and Description
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String ownerId, Direction direction) Deprecated. replaced by getSubscriptions(ResourceResolver, String, SubscriptionType, Direction)
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String subTypeId, int startIndex, int size) Deprecated. replaced by getSubscriptions(ResourceResolver, String, SubscriptionType, int, int)
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String subscribeTo, java.lang.String owner, java.lang.String... types) Gets subscription objects for a target and owner combination.
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String ownerId, SubscriptionType subscriptionType, Direction direction) Gets subscriptions for the specified owner.
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String subTypeId, SubscriptionType subscriptionType, int startIndex, int size) Get the subscription of the specified subTypeId and subscriptionType
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String subTypeId, UgcFilter filter, int startIndex, int size) Deprecated. replaced by getSubscriptions(ResourceResolver, String, UgcFilter, SubscriptionType, int, int)
java.util.List<Subscription>	getSubscriptions(ResourceResolver resolver, java.lang.String subTypeId, UgcFilter filter, SubscriptionType subscriptionType, int startIndex, int size) Get the subscription of the specified subTypeId, the specified filter, and subscriptionType

Method Detail

getSubscriptions

@CheckForNull
java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                                            java.lang.String subscribeTo,
                                                            java.lang.String owner,
                                                            java.lang.String... types)

Gets subscription objects for a target and owner combination.

Parameters:

resolver - the resolver to use to read the subscription

subscribeTo - the target of the subscription

owner - the owner of this particular subscription

types - String...

Returns:

a subscription object or null if not found

getSubscriptions

@Nonnull
 @Deprecated
java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                                                    java.lang.String ownerId,
                                                                    Direction direction)

Deprecated. replaced by getSubscriptions(ResourceResolver, String, SubscriptionType, Direction)

Gets subscriptions for the specified owner.

Parameters:

resolver - the resolver to use to read the subscriptions

ownerId - a path to the owner of the subscription

direction - direction of the relationship

Returns:

a list of subscriptions

getSubscriptions

@Nonnull
java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                                       java.lang.String ownerId,
                                                       SubscriptionType subscriptionType,
                                                       Direction direction)

Gets subscriptions for the specified owner.

Parameters:

resolver - the resolver to use to read the subscriptions

ownerId - a path to the owner of the subscription

subscriptionType - the type of subscription

direction - direction of the relationship

Returns:

a list of subscriptions

getSubscriptions

@Nonnull
 @Deprecated
java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                                                    java.lang.String subTypeId,
                                                                    int startIndex,
                                                                    int size)

Deprecated. replaced by getSubscriptions(ResourceResolver, String, SubscriptionType, int, int)

Get the subscription of the specified subTypeId and subscriptionType

Parameters:

resolver - the resolver to be used in the query

subTypeId - the sub type id, such as RESOURCE or USER

startIndex - the start index

size - the number of element to be retrieved

Returns:

a list of subscriptions

getSubscriptions

java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                              java.lang.String subTypeId,
                                              SubscriptionType subscriptionType,
                                              int startIndex,
                                              int size)

Get the subscription of the specified subTypeId and subscriptionType

Parameters:

resolver - the resolver to be used in the query

subTypeId - the sub type id, such as RESOURCE or USER

subscriptionType - the subscription type, such as SUBSCRIPTIONS or NOTIFICATIONS

startIndex - the start index

size - the number of element to be retrieved

Returns:

a list of subscriptions

getSubscriptions

java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                              java.lang.String subTypeId,
                                              UgcFilter filter,
                                              int startIndex,
                                              int size)

Deprecated. replaced by getSubscriptions(ResourceResolver, String, UgcFilter, SubscriptionType, int, int)

Get the subscription of the specified subTypeId, the specified filter, and subscriptionType

Parameters:

resolver - the resolver to be used in the query

subTypeId - the sub type id, such as RESOURCE or USER

filter - UgcFilter

startIndex - the start index

size - the number of element to be retrieved

Returns:

a list of subscriptions

getSubscriptions

java.util.List<Subscription> getSubscriptions(ResourceResolver resolver,
                                              java.lang.String subTypeId,
                                              UgcFilter filter,
                                              SubscriptionType subscriptionType,
                                              int startIndex,
                                              int size)

Get the subscription of the specified subTypeId, the specified filter, and subscriptionType

Parameters:

resolver - the resolver to be used in the query

subTypeId - the sub type id, such as RESOURCE or USER

subscriptionType - the subscription type, such as SUBSCRIPTIONS or NOTIFICATIONS

startIndex - the start index

filter - UgcFilter

size - the number of element to be retrieved

Returns:

a list of subscriptions