|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.proxy.ReadTrackerProxy
public class ReadTrackerProxy
Protection proxy for ReadTracker instances.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.ReadTracker |
---|
READ, UNREAD, UPDATED |
Constructor Summary | |
---|---|
ReadTrackerProxy(ReadTracker readTracker,
AuthToken authToken,
Permissions permissions)
Creates a new ForumProxy object. |
Method Summary | |
---|---|
int |
getReadStatus(User user,
ForumMessage message)
Returns the read status on the specified message. |
int |
getReadStatus(User user,
ForumThread thread)
Returns the read status on the specified thread. |
int |
getUnreadMessageCount(User user,
Forum forum)
Returns the count of unread messages that the user has in the forum. |
int |
getUnreadMessageCount(User user,
ForumCategory category)
Returns the count of unread messages that the user has in the category. |
java.util.Iterator |
getUnreadMessages(User user,
Forum forum)
Returns an iterator for the unread messages in the forum. |
java.util.Iterator |
getUnreadMessages(User user,
ForumCategory category)
Returns an iterator for the unread messages in the category. |
int |
getUnreadThreadCount(User user,
Forum forum)
Returns the count of unread threads that the user has in the forum. |
int |
getUnreadThreadCount(User user,
ForumCategory category)
Returns the count of unread threads that the user has in the category. |
java.util.Iterator |
getUnreadThreads(User user,
Forum forum)
Returns an iterator for the unread threads in the forum. |
java.util.Iterator |
getUnreadThreads(User user,
ForumCategory category)
Returns an iterator for the unread threads in the category. |
boolean |
isReadTrackingEnabled()
Returns true if read tracking is enabled, false otherwise. |
void |
markRead(User user,
Forum forum)
Marks an entire forum as read up until the current instant in time. |
void |
markRead(User user,
ForumCategory category)
Marks an entire category as read up until the current instant in time. |
void |
markRead(User user,
ForumMessage message)
Marks an individual message as read. |
void |
setReadTrackingEnabled(boolean enabled)
Enables or disables the read tracking feature. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReadTrackerProxy(ReadTracker readTracker, AuthToken authToken, Permissions permissions)
readTracker
- the read tracker to protect by proxyauthToken
- the user's auth tokenpermissions
- the permissions to use with this proxy.Method Detail |
---|
public boolean isReadTrackingEnabled()
ReadTracker
isReadTrackingEnabled
in interface ReadTracker
public void setReadTrackingEnabled(boolean enabled) throws UnauthorizedException
ReadTracker
setReadTrackingEnabled
in interface ReadTracker
enabled
- true to enable read tracking, false otherwise.
UnauthorizedException
- if the user is not a system admin.public int getReadStatus(User user, ForumThread thread)
ReadTracker
getReadStatus
in interface ReadTracker
user
- the user reading the thread.thread
- the thread to check read status on.
public int getReadStatus(User user, ForumMessage message)
ReadTracker
getReadStatus
in interface ReadTracker
user
- the user reading the message.message
- the message to check read status on.
public void markRead(User user, ForumMessage message)
ReadTracker
markRead
in interface ReadTracker
user
- the user that read the message.message
- the message that should be marked as read.public void markRead(User user, Forum forum)
ReadTracker
markRead
in interface ReadTracker
user
- the user marking the forum as read.forum
- the forum to mark as read.public void markRead(User user, ForumCategory category)
ReadTracker
markRead
in interface ReadTracker
user
- the user marking the forum as read.category
- the category to mark as read.public int getUnreadThreadCount(User user, Forum forum)
ReadTracker
getUnreadThreadCount
in interface ReadTracker
user
- the user to check unread threads for.forum
- the forum to check unread threads in.
public int getUnreadThreadCount(User user, ForumCategory category)
ReadTracker
getUnreadThreadCount
in interface ReadTracker
user
- the user to check unread threads for.category
- the category to check unread threads in.
public java.util.Iterator getUnreadThreads(User user, Forum forum)
ReadTracker
getUnreadThreads
in interface ReadTracker
user
- the user to check unread threads for.forum
- the forum to check unread threads in.
public java.util.Iterator getUnreadThreads(User user, ForumCategory category)
ReadTracker
getUnreadThreads
in interface ReadTracker
user
- the user to check unread threads for.category
- the category to check unread threads in.
public int getUnreadMessageCount(User user, Forum forum)
ReadTracker
getUnreadMessageCount
in interface ReadTracker
user
- user the user to check unread messages for.forum
- forum the forum to check unread messages in.
public int getUnreadMessageCount(User user, ForumCategory category)
ReadTracker
getUnreadMessageCount
in interface ReadTracker
user
- user the user to check unread messages for.category
- category the forum to check unread messages in.
public java.util.Iterator getUnreadMessages(User user, Forum forum)
ReadTracker
getUnreadMessages
in interface ReadTracker
user
- user the user to check unread messages for.forum
- forum the forum to check unread messages in.
public java.util.Iterator getUnreadMessages(User user, ForumCategory category)
ReadTracker
getUnreadMessages
in interface ReadTracker
user
- user the user to check unread messages for.category
- forum the category to check unread messages in.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |