com.jivesoftware.community
Interface Presence

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

String	getID() Returns the unique ID for this status.
String	getIPAddress() Returns the IP address of the user.
Date	getLastUpdateTime() Return the time when the presence was last updated (when the user last visited).
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.
String	getUsername() Returns the unique username for this status.
void	setLastUpdateTime(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

STATUS_ONLINE

static final int STATUS_ONLINE

See Also:

Constant Field Values

STATUS_IDLE

static final int STATUS_IDLE

See Also:

Constant Field Values

STATUS_INVISIBLE

static final int STATUS_INVISIBLE

See Also:

Constant Field Values

STATUS_AWAY

static final int STATUS_AWAY

See Also:

Constant Field Values

Method Detail

getID

String getID()

Returns the unique ID for this status. The ID in the default implmentation is the user's session ID, which is unique within a single JVM.

Returns:

the unique ID for the presence.

getUsername

String getUsername()

Returns the unique username for this status.

Returns:

the unique ID for the presence.

getUser

User getUser()

Return the user owning the presence.

Returns:

the presence owner.

getIPAddress

String getIPAddress()

Returns the IP address of the user.

Returns:

the IP address of the user.

getLoginTime

Date getLoginTime()

Return the time when the presence was created.

Returns:

the time when the presence was created.

getLastUpdateTime

Date getLastUpdateTime()

Return the time when the presence was last updated (when the user last visited).

Returns:

the time when the presence was last updated (when the user last visited).

setLastUpdateTime

void setLastUpdateTime(Date time)
                       throws UnauthorizedException

Set the time when the presence was last updated (when the user last visited).

Parameters:

time - the time of the last update.

Throws:

UnauthorizedException - if not the user or an admin.

setLastUpdateTime

void setLastUpdateTime(long time)
                       throws UnauthorizedException

Sets the time when the presence was last updated (when the user last visited).

Parameters:

time - the time of the last update (in milliseconds).

Throws:

UnauthorizedException - if not the user or an admin.

getStatus

int getStatus()

Returns the status of the presence.

Returns:

the status of the presence.

setStatus

void setStatus(int status)
               throws UnauthorizedException

Sets the status of the user.

Parameters:

status - the status of the user.

Throws:

UnauthorizedException