com.adobe.cq.social.messaging.client.api

Interface MessageBoxSocialComponent<P extends MessageSocialComponent,C extends CommentCollectionConfiguration>

All Superinterfaces:

CommentCollection<P,C>, SocialCollectionComponent, SocialComponent

public interface MessageBoxSocialComponent<P extends MessageSocialComponent,C extends CommentCollectionConfiguration>
extends CommentCollection<P,C>

Represents a Messaging MessageBox.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NODE_TYPE The node type for message box nodes.
static java.lang.String	PN_FOLDER_PATHS property to customize folders to look up the messages in for this message box.
static java.lang.String	PN_SIZE Name of the property that stores the message box size.
static java.lang.String	RESOURCE_TYPE The resource type value for a MessageBoxSocialComponent.

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
long	getCount(MessageCounts.CountType countType) Queries the value of the specified count type for this message box.
java.util.List<java.lang.String>	getFolderPaths()
java.util.Map<java.lang.String,java.lang.Long>	getMessageCounts()
PageInfo	getPageInfo() Gets information about the pages for this collection.
long	getSize() Get the size of the message box in bytes.
Usage	getUserStatistics() get the usage statistics of the user.

Methods inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollection

getConfiguration, getCreated, getLastModified, getMayPost, isTaggingAllowed

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

PN_FOLDER_PATHS

static final java.lang.String PN_FOLDER_PATHS

property to customize folders to look up the messages in for this message box.

See Also:

Constant Field Values

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

The resource type value for a MessageBoxSocialComponent.

See Also:

Constant Field Values

NODE_TYPE

static final java.lang.String NODE_TYPE

The node type for message box nodes.

See Also:

Constant Field Values

PN_SIZE

static final java.lang.String PN_SIZE

Name of the property that stores the message box size.

See Also:

Constant Field Values

Method Detail

getPageInfo

@Nonnull
PageInfo getPageInfo()

Description copied from interface: CommentCollection

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

Specified by:

getPageInfo in interface CommentCollection<P extends MessageSocialComponent,C extends CommentCollectionConfiguration>

Returns:

PageInfo

getFolderPaths

@Nonnull
java.util.List<java.lang.String> getFolderPaths()

Returns:

paths under which this message box will search for messages.

getMessageCounts

@Nonnull
java.util.Map<java.lang.String,java.lang.Long> getMessageCounts()

Returns:

A Map of aggregated message counts for any mailbox located beneath the path of this message box.

getUserStatistics

@Nonnull
Usage getUserStatistics()
                          throws RepositoryException,
                                 LoginException

get the usage statistics of the user.

Returns:

Usage

Throws:

RepositoryException - RepositoryException if some exception occurs in calculating the statistics.

LoginException - LoginException

getCount

long getCount(MessageCounts.CountType countType)

Queries the value of the specified count type for this message box.

Parameters:

countType - The type of count to return. See MessageCounts.CountType

Returns:

The value of the specified count type.

getSize

long getSize()

Get the size of the message box in bytes.

Returns:

The size of the message box in bytes.