com.adobe.cq.social.notifications.client.api

Interface SocialNotificationCollection

All Superinterfaces:

SocialCollectionComponent, SocialComponent

All Known Implementing Classes:

AbstractSocialNotificationCollection

public interface SocialNotificationCollection
extends SocialCollectionComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_CHANNEL_ID
static java.lang.String	DEFAULT_CHANNEL
static java.lang.String	DEFAULT_MAX_NOTIFICATIONS
static java.lang.String	PROP_CHANNEL_ID
static java.lang.String	PROP_MAX_NOTIFICATIONS
static java.lang.String	PROP_USER_ID
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	getChannelId() Get the channel id of this collection
PageInfo	getPageInfo() Gets information about the pages for this collection.
long	getUnreadCount() Get the number of unread notifications
java.lang.String	getUserId() Get the userId

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Field Detail

PROP_USER_ID

static final java.lang.String PROP_USER_ID

See Also:

Constant Field Values

PROP_CHANNEL_ID

static final java.lang.String PROP_CHANNEL_ID

See Also:

Constant Field Values

PROP_MAX_NOTIFICATIONS

static final java.lang.String PROP_MAX_NOTIFICATIONS

See Also:

Constant Field Values

ALL_CHANNEL_ID

static final java.lang.String ALL_CHANNEL_ID

See Also:

Constant Field Values

DEFAULT_MAX_NOTIFICATIONS

static final java.lang.String DEFAULT_MAX_NOTIFICATIONS

See Also:

Constant Field Values

DEFAULT_CHANNEL

static final java.lang.String DEFAULT_CHANNEL

See Also:

Constant Field Values

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getChannelId

java.lang.String getChannelId()

Get the channel id of this collection

Returns:

String channel ID

getUserId

java.lang.String getUserId()

Get the userId

Returns:

String user ID

getUnreadCount

long getUnreadCount()

Get the number of unread notifications

Returns:

long unread count

getPageInfo

PageInfo getPageInfo()

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Returns:

information about the pagination system