| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
presence service session. A PresenceSession is use to access and advertise presence information. A presence information access unit or user agent, is called a presentity. Actual presence information is accessed by performing actions on a presentity.
| Field Summary | |
| static java.lang.String | STATUS_AWAYuser agent online / user unavailable | 
| static java.lang.String | STATUS_BUSYuser agent online / user involved in other tasks and of limited availability | 
| static java.lang.String | STATUS_CHATuser agent chatting | 
| static java.lang.String | STATUS_CLOSEDuser agent offline / user unreachable | 
| static java.lang.String | STATUS_FORWARDEDuser agent offline / one-way messages forwarded to other delivery mechanism | 
| static java.lang.String | STATUS_IDLEExtended status to signify that the user is away. | 
| static java.lang.String | STATUS_OPENuser agent online / user available to communicate | 
| static java.lang.String | STATUS_OTHERother status | 
| static java.lang.String | STATUS_PENDINGuser's subscription is pending | 
| Method Summary | |
|  void | addAccessRule(PresenceAccessRule rule)Deprecated. Instead use setPrivacyList | 
|  void | addPresenceServiceListener(PresenceServiceListener listener)Add an additional PresenceServiceListener to receive the event notifications. | 
|  void | authorize(java.lang.String presentity)Authorize the presentity to receive presence updates The Presentity should have earlier requested for the Approval | 
|  void | cancel(java.lang.String presentity)cancels the previously granted subscription approval or deny the subscription request. | 
|  Presence | fetchPresence(java.lang.String presentity)retrieves presence information from the presence store synchronously | 
|  Presence[] | fetchPresence(java.lang.String[] presentity)retrieves presence information from the presence store synchronously | 
|  java.util.Collection | getAccessRules(java.lang.String presentity)Deprecated. Instead use getPrivacyList | 
|  void | initialize(PresenceServiceListener listener)intialize the service by providing a PresenceServiceListener. | 
|  void | publish(Presence presence)Update a unit of presence information in the relevant presence stores. | 
|  void | publish(Presence presence,
        java.lang.String rcpt)Send a unit of presence information to a particular user | 
|  void | removePresenceServiceListener(PresenceServiceListener listener)Removes an already added ConfereneServiceListener. | 
|  void | saveAccessRules()Deprecated. Instead use setPrivacyList | 
|  void | subscribe(java.lang.String presentity)Subscribes to the presentity. | 
|  void | subscribe(java.lang.String[] presentity)Subscribes to the multiple presentity. | 
|  void | unsubscribe(java.lang.String presentity)Cancels any subscription made for a presentity. | 
|  void | unsubscribe(java.lang.String[] presentity)Cancels any subscription made to the specified presentities. | 
| Field Detail | 
public static final java.lang.String STATUS_OPEN
public static final java.lang.String STATUS_CLOSED
public static final java.lang.String STATUS_AWAY
public static final java.lang.String STATUS_IDLE
public static final java.lang.String STATUS_BUSY
public static final java.lang.String STATUS_FORWARDED
public static final java.lang.String STATUS_CHAT
public static final java.lang.String STATUS_OTHER
public static final java.lang.String STATUS_PENDING
| Method Detail | 
public void subscribe(java.lang.String presentity)
               throws CollaborationException
presentity - presentity url
CollaborationException
public void subscribe(java.lang.String[] presentity)
               throws CollaborationException
presentity - a list of presentity urls
CollaborationException
public void unsubscribe(java.lang.String presentity)
                 throws CollaborationException
presentity - presentity url
CollaborationException
public void unsubscribe(java.lang.String[] presentity)
                 throws CollaborationException
presentity - array of presentity urls
CollaborationException
public void publish(Presence presence)
             throws CollaborationException
presence - Presence information
CollaborationException
public void publish(Presence presence,
                    java.lang.String rcpt)
             throws CollaborationException
presence - Presence informationrcpt - The recipeint to whom the presence is directed.
CollaborationException
public Presence fetchPresence(java.lang.String presentity)
                       throws CollaborationException
presentity - presentity url
CollaborationException
public Presence[] fetchPresence(java.lang.String[] presentity)
                         throws CollaborationException
presentity - presentity url
CollaborationException
public void cancel(java.lang.String presentity)
            throws CollaborationException
presentity - presentity url
CollaborationException
public void authorize(java.lang.String presentity)
               throws CollaborationException
presentity - presentity url
CollaborationException
public void addAccessRule(PresenceAccessRule rule)
                   throws CollaborationException
rule - access rule
CollaborationException
public java.util.Collection getAccessRules(java.lang.String presentity)
                                    throws CollaborationException
presentity - address of the protected presentity
CollaborationException
public void saveAccessRules()
                     throws CollaborationException
CollaborationException
public void initialize(PresenceServiceListener listener)
                throws CollaborationException
listener - PresenceServiceListener
CollaborationExceptionpublic void addPresenceServiceListener(PresenceServiceListener listener)
initializing PresenceService.
listener - PresenceServiceListener The PresenceServiceListener to be added.public void removePresenceServiceListener(PresenceServiceListener listener)
listener - PresenceServiceListener The PresenceServiceListener to be removed.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||