|
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 |
public interface Presence
A Presence encapsulates information relating to the owning user such as login time, status and last update time.
Field Summary | |
---|---|
static int |
STATUS_AWAY
|
static int |
STATUS_IDLE
|
static int |
STATUS_INVISIBLE
|
static int |
STATUS_ONLINE
|
Method Summary | |
---|---|
java.lang.String |
getID()
Returns the unique ID for this status. |
java.lang.String |
getIPAddress()
Returns the IP address of the user. |
java.util.Date |
getLastUpdateTime()
Return the time when the presence was last updated (when the user last visited). |
java.util.Date |
getLoginTime()
Return the time when the presence was created. |
int |
getStatus()
Returns the status of the presence. |
User |
getUser()
Return the user owning the presence. |
java.lang.String |
getUsername()
Returns the unique username for this status. |
void |
setLastUpdateTime(java.util.Date time)
Set the time when the presence was last updated (when the user last visited). |
void |
setLastUpdateTime(long time)
Sets the time when the presence was last updated (when the user last visited). |
void |
setStatus(int status)
Sets the status of the user. |
Field Detail |
---|
static final int STATUS_ONLINE
static final int STATUS_IDLE
static final int STATUS_INVISIBLE
static final int STATUS_AWAY
Method Detail |
---|
java.lang.String getID()
java.lang.String getUsername()
User getUser()
java.lang.String getIPAddress()
java.util.Date getLoginTime()
java.util.Date getLastUpdateTime()
void setLastUpdateTime(java.util.Date time) throws UnauthorizedException
time
- the time of the last update.
UnauthorizedException
- if not the user or an admin.void setLastUpdateTime(long time) throws UnauthorizedException
time
- the time of the last update (in milliseconds).
UnauthorizedException
- if not the user or an admin.int getStatus()
void setStatus(int status) throws UnauthorizedException
status
- the status of the user.
UnauthorizedException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |