com.adobe.cq.social.subscriptions.client.api

Interface SubscriptionCollection

All Superinterfaces:

SocialComponent

All Known Implementing Classes:

AbstractSubscriptionCollection

public interface SubscriptionCollection
extends SocialComponent

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_TYPE

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
String	getOwner() Get the owner of the subscription
String	getPath() Get the path of this subscription
Map<String,SubscriptionStatus>	getStates() Get the subscription status of this collection
String	getSubscribedId() Get the id the user wants to subscribe to.
String[]	getTypes() Get the list of subscription types
boolean	isSubscribed() Check if there is a selection in this collection
boolean	isUserLoggedIn() Check if there is a login session

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getSubscribedId

String getSubscribedId()

Get the id the user wants to subscribe to. The id can be a resource path, or a user id.

Returns:

the subscribed id

getOwner

String getOwner()

Get the owner of the subscription

Returns:

getPath

String getPath()

Get the path of this subscription

getTypes

String[] getTypes()

Get the list of subscription types

Returns:

getStates

Map<String,SubscriptionStatus> getStates()

Get the subscription status of this collection

Returns:

isSubscribed

boolean isSubscribed()

Check if there is a selection in this collection

isUserLoggedIn

boolean isUserLoggedIn()

Check if there is a login session