Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.community
Interface ReadTracker

All Superinterfaces:
JiveManager

public interface ReadTracker
extends JiveManager

A way to track the read status of forum threads and messages. Note, this does not cover blogs, blog posts or wiki documents.

This feature is optional in that other Jive classes do not call this API. Instead, the UI layer must explicitly check and mark messages as read or unread. Because there is potentially a high overhead associated with this feature:

To implement this feature, a skin author must manually mark each message as read as appropriate. For example, in a threaded view, this would be on the page that displays the message. In a flat view where many messages are show on each page, the markRead method should be called for each message on the page. There is no need to mark threads as read since that information can be automatically determined from which messages are read.

There are three states that each thread or message can be in:

To set a custom time window (in number of days), set the Jive property readTracker.timeWindow. If no property is set, the default value of 30 days will be used.

See Also:
JiveContext.getReadTracker()

Field Summary
static int DEFAULT_TRACKING_THRESHOLD_DAYS
          Default value used to determine number of days old a thread can be before being marked as read.
static int READ
          Status to indicate that the object has been read.
static int UNREAD
          Status to indicate that the object has never been read.
static int UPDATED
          Status to indicate the object has been updated since the last time a read was done.
 
Method Summary
 
Methods inherited from interface com.jivesoftware.community.JiveManager
destroy
 

Field Detail

DEFAULT_TRACKING_THRESHOLD_DAYS

static final int DEFAULT_TRACKING_THRESHOLD_DAYS
Default value used to determine number of days old a thread can be before being marked as read.

See Also:
Constant Field Values

UNREAD

static final int UNREAD
Status to indicate that the object has never been read.

See Also:
Constant Field Values

UPDATED

static final int UPDATED
Status to indicate the object has been updated since the last time a read was done. For example, if a new message is added to a thread.

See Also:
Constant Field Values

READ

static final int READ
Status to indicate that the object has been read.

See Also:
Constant Field Values

Jive Product Page

Copyright © 1999-2007 Jive Software.