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

Interface MessageCounts

public interface MessageCounts

Represents counts of messages in a message box.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageCounts.CountType The count type.

Method Summary

Modifier and Type	Method and Description
void	decrementCount(MessageCounts.CountType type) Decrement a count proprety by 1.
void	decrementTotalSize(long decrementBy) Decrement value of the total size of the message box.
long	getCount(MessageCounts.CountType type) Get the count type specified by the parameter.
long	getDeletedReadCount()
long	getDeletedUnreadCount()
long	getNonDeletedReadCount()
long	getNonDeletedUnreadCount()
long	getTotalCount() Get the total count of messages in the message box.
long	getTotalSize() Get the total size of the message box.
void	incrementCount(MessageCounts.CountType type) Increment a count property by 1.
void	incrementTotalSize(long incrementBy) Increment the value of the total size of the message box.

Method Detail

getNonDeletedUnreadCount

long getNonDeletedUnreadCount()

Returns:

count of not trashed unread messages.

getNonDeletedReadCount

long getNonDeletedReadCount()

Returns:

count of not trashed read messages.

getDeletedUnreadCount

long getDeletedUnreadCount()

Returns:

count of trashed unread messages.

getDeletedReadCount

long getDeletedReadCount()

Returns:

count of trashed+read messages.

getCount

long getCount(MessageCounts.CountType type)

Get the count type specified by the parameter.

Parameters:

type - The count type to return.

Returns:

The count.

getTotalCount

long getTotalCount()

Get the total count of messages in the message box.

Returns:

The total count.

incrementCount

void incrementCount(@Nonnull
                    MessageCounts.CountType type)
             throws PersistenceException

Increment a count property by 1.

Parameters:

type - The MessageCounts.CountType

Throws:

PersistenceException - If the increment fails.

decrementCount

void decrementCount(@Nonnull
                    MessageCounts.CountType type)
             throws PersistenceException

Decrement a count proprety by 1.

Parameters:

type - The MessageCounts.CountType

Throws:

PersistenceException - If the decrement fails.

getTotalSize

long getTotalSize()

Get the total size of the message box.

Returns:

The total size of the message box.

incrementTotalSize

void incrementTotalSize(long incrementBy)
                 throws PersistenceException

Increment the value of the total size of the message box. Passing in a negative value performs a decrement.

Parameters:

incrementBy - The amount to increment by.

Throws:

PersistenceException - If the increment fails.

decrementTotalSize

void decrementTotalSize(long decrementBy)
                 throws PersistenceException

Decrement value of the total size of the message box.

Parameters:

decrementBy - The amount by which to decrement the total size of the message box.

Throws:

PersistenceException - If the decrement fails.