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 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
Map<String,Map<String,ValueMap>>	getNotificationCategorySettings() Get the notification category settings for all the channels.
Map<String,Collection<String>>	getNotificationChannelCategories() List of notification categories
Collection<String>	getNotificationChannels() List of notification channels
Map<String,Map<String,ValueMap>>	getSubscriptionCategorySettings()
Map<String,Collection<String>>	getSubscriptionChannelCategories()
Collection<String>	getSubscriptionChannels() List of subscription channels
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 String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getNotificationChannels

Collection<String> getNotificationChannels()

List of notification channels

Returns:

getSubscriptionChannels

Collection<String> getSubscriptionChannels()

List of subscription channels

Returns:

getNotificationChannelCategories

Map<String,Collection<String>> getNotificationChannelCategories()
                                                         throws RepositoryException

List of notification categories

Throws:

RepositoryException

getSubscriptionChannelCategories

Map<String,Collection<String>> getSubscriptionChannelCategories()
                                                         throws RepositoryException

Throws:

RepositoryException

getNotificationCategorySettings

Map<String,Map<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:

Throws:

RepositoryException

getSubscriptionCategorySettings

Map<String,Map<String,ValueMap>> getSubscriptionCategorySettings()
                                                          throws RepositoryException

Throws:

RepositoryException

getUserPath

String getUserPath()

Get user path

Returns:

string with user path