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

Interface UserSubscriptionPreferences

All Superinterfaces:

SocialComponent

public interface UserSubscriptionPreferences
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.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueMap>>	getNotificationCategorySettings() Get the notification category settings for all the channels.
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getNotificationChannelCategories() List of notification categories
java.util.Collection<java.lang.String>	getNotificationChannels() List of notification channels
java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueMap>>	getSubscriptionCategorySettings()
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getSubscriptionChannelCategories()
java.util.Collection<java.lang.String>	getSubscriptionChannels() List of subscription channels
java.lang.String	getUserPath() Get user path

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

getNotificationChannels

java.util.Collection<java.lang.String> getNotificationChannels()

List of notification channels

Returns:

Collection

getSubscriptionChannels

java.util.Collection<java.lang.String> getSubscriptionChannels()

List of subscription channels

Returns:

Collection

getNotificationChannelCategories

java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getNotificationChannelCategories()
                                                                                                 throws RepositoryException

List of notification categories

Returns:

Map of channel categories

Throws:

RepositoryException - Repository Exception

getSubscriptionChannelCategories

java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getSubscriptionChannelCategories()
                                                                                                 throws RepositoryException

Throws:

RepositoryException

getNotificationCategorySettings

java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueMap>> getNotificationCategorySettings()
                                                                                                  throws RepositoryException

Get the notification category settings for all the channels. The key of the map is the channel id, the value of each item in the map is a Map, which provides the category settings.

Returns:

Map of notification category settings

Throws:

RepositoryException - Repository Exception

getSubscriptionCategorySettings

java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueMap>> getSubscriptionCategorySettings()
                                                                                                  throws RepositoryException

Throws:

RepositoryException

getUserPath

java.lang.String getUserPath()

Get user path

Returns:

string with user path