org.symphonyoss.client.services

Class PresenceService

java.lang.Object

org.symphonyoss.client.services.PresenceService

All Implemented Interfaces:

PresenceFeedListener

public class PresenceService
extends java.lang.Object
implements PresenceFeedListener

**NOTE** This service has been suspended for real-time monitoring of events as per LLC. Polling for all user could cause head end (POD) failure.

Presence service provides monitoring of user presence events. It also provides helper methods to retrieve user presence. Alternatively the PresenceClient can be used directly.

Constructor Summary

Constructors

Constructor and Description
PresenceService(SymphonyClient symClient)

Method Summary

Modifier and Type	Method and Description
void	addPresenceListener(PresenceListener presenceListener) This will start the presence worker thread
SymPresence	getUserPresence(java.lang.String email) Return a individual user presence by email
SymPresence	getUserPresence(SymUser symUser, java.lang.Boolean local) Return a individual user presence by userID
void	onEvent(SymPresence symPresence) Listen to all state changes from presence feed polling
void	removePresenceListener(PresenceListener presenceListener)
void	shutdown() Shutdown all underlying threads

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PresenceService

public PresenceService(SymphonyClient symClient)

Method Detail

getUserPresence

public SymPresence getUserPresence(SymUser symUser,
                                   java.lang.Boolean local)
                            throws PresenceException

Return a individual user presence by userID

Parameters:

symUser - symUser to lookup

local - Search local pod

Returns:

SymPresence presence

Throws:

PresenceException - Thrown by underlying Symphony API calls

getUserPresence

public SymPresence getUserPresence(java.lang.String email)
                            throws PresenceException

Return a individual user presence by email

Parameters:

email - email to lookup

Returns:

SymPresence presence

Throws:

PresenceException - Thrown by underlying Symphony API calls

addPresenceListener

public void addPresenceListener(PresenceListener presenceListener)

This will start the presence worker thread

Parameters:

presenceListener - to handle callbacks.

removePresenceListener

public void removePresenceListener(PresenceListener presenceListener)

onEvent

public void onEvent(SymPresence symPresence)

Description copied from interface: PresenceFeedListener

Listen to all state changes from presence feed polling

Specified by:

onEvent in interface PresenceFeedListener

Parameters:

symPresence - received from presence feed polling

shutdown

public void shutdown()

Shutdown all underlying threads