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 java.lang.String	RESOURCE_TYPE

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOwner() Get the owner of the subscription
java.lang.String	getPath() Get the path of this subscription
java.util.Map<java.lang.String,SubscriptionStatus>	getStates() Get the subscription status of this collection
java.lang.String	getSubscribedId() Get the id the user wants to subscribe to.
java.lang.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, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getSubscribedId

java.lang.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

java.lang.String getOwner()

Get the owner of the subscription

Returns:

String

getPath

java.lang.String getPath()

Get the path of this subscription

Returns:

String

getTypes

java.lang.String[] getTypes()

Get the list of subscription types

Returns:

String[]

getStates

java.util.Map<java.lang.String,SubscriptionStatus> getStates()

Get the subscription status of this collection

Returns:

Map

isSubscribed

boolean isSubscribed()

Check if there is a selection in this collection

Returns:

boolean

isUserLoggedIn

boolean isUserLoggedIn()

Check if there is a login session

Returns:

boolean