|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Watch
A watch is a way for a user to track updates to an object. Users create watches on individual objects and can specify whether or not they want to be notified by email (or some other way) each time the object is updated.
Three kinds of watch types are available:
Field Summary | |
---|---|
static int |
BATCH_EMAIL_WATCH
Batch email watch type. |
static int |
EMAIL_WATCH
Email watch type. |
static int |
NORMAL_WATCH
Normal watch type. |
Method Summary | |
---|---|
long |
getObjectID()
Returns the object ID of the object being watched. |
int |
getObjectType()
Returns the object type of the object being watched. |
User |
getUser()
Returns the user who is associated with this watch. |
int |
getWatchType()
Returns the type of the watch. |
boolean |
isExpirable()
Returns whether this watch is expirable or not. |
void |
setExpirable(boolean expirable)
Sets whether this watch is expirable or not. |
void |
setWatchType(int watchType)
Sets the watch type. |
Field Detail |
---|
static final int NORMAL_WATCH
static final int EMAIL_WATCH
static final int BATCH_EMAIL_WATCH
Method Detail |
---|
User getUser()
long getObjectID()
int getObjectType()
int getWatchType()
void setWatchType(int watchType)
watchType
- the type of watch this should be.boolean isExpirable()
void setExpirable(boolean expirable) throws UnauthorizedException
expirable
- true if the watch is expirable, false if not.
UnauthorizedException
- if not a system admin or the user.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |