| 
 | ||||||||||
| 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.
 A presentity is identified by an address, whose format is defined in
 RFC 822 (addr-spec).
 Example:
 
 fred@example.com
 
The Presence information format is defined in a iCAPI's pseudo-DTD.
| 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_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 | 
| Method Summary | |
|  void | addAccessRule(PresenceAccessRule rule)Deprecated. Instead use setPrivacyList | 
|  void | cancel(java.lang.String presentity)cancels the previously granted subscription approval. | 
|  java.lang.String | fetch(java.lang.String presentity)retrieves presence information from the presence store synchronously | 
|  java.lang.String[] | fetch(java.lang.String[] presentity)retrieves presence information from the presence store synchronously | 
|  void | fetch(java.lang.String[] presentity,
      PresenceInfoListener listener)retrieves presence information from the presence store asynchronously about multiple presentities | 
|  void | fetch(java.lang.String presentity,
      PresenceInfoListener listener)retrieves presence information from the presence store asynchronously | 
|  java.util.Collection | getAccessRules(java.lang.String presentity)Deprecated. Instead use getPrivacyList | 
|  void | publish(java.lang.String presenceInfo)Update a unit of presence information in the relevant presence stores. | 
|  void | saveAccessRules()Deprecated. Instead use setPrivacyList | 
|  PresenceSubscription | subscribe(java.lang.String[] presentity,
          PresenceInfoListener listener)Subscribe to multiple presentities at once. | 
|  PresenceSubscription | subscribe(java.lang.String[] presentity,
          PresenceInfoListener listener,
          java.util.Date expires)Subscribe to multiple presentities at once, i.e. ask to be notified of any presence information update pertaining to any of these presentities. | 
|  PresenceSubscription | subscribe(java.lang.String presentity,
          PresenceInfoListener listener)subscribe to a presentity. | 
|  PresenceSubscription | subscribe(java.lang.String presentity,
          PresenceInfoListener listener,
          java.util.Date expires)subscribe to a presentity, i.e. ask to be notified of any presence information update pertaining to this 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_OTHER
| Method Detail | 
public PresenceSubscription subscribe(java.lang.String presentity,
                                      PresenceInfoListener listener)
                               throws CollaborationException
presentity - presentity urllistener - callback object used to notify the caller whenever 
 a relevant presence update happens.
CollaborationException - failure to register the subscription
 in the pub/sub subsystem.
public PresenceSubscription subscribe(java.lang.String[] presentity,
                                      PresenceInfoListener listener)
                               throws CollaborationException
presentity - array of presentity urllistener - callback object used to notify the caller whenever
 a relevant presence update happens.
CollaborationException - failure to register the subscription
 in the pub/sub subsystem.
public PresenceSubscription subscribe(java.lang.String presentity,
                                      PresenceInfoListener listener,
                                      java.util.Date expires)
                               throws CollaborationException
presentity - presentity urllistener - callback object used to notify the caller whenever 
 a relevant presence update happens.expires - expiration date for this subscription.
failure - to register the subscription
 in the pub/sub subsystem.
CollaborationException
public PresenceSubscription subscribe(java.lang.String[] presentity,
                                      PresenceInfoListener listener,
                                      java.util.Date expires)
                               throws CollaborationException
presentity - array of presentity urlslistener - callback object used to notify the caller whenever
 a relevant presence update happens.expires - expiration date for this subscription.
failure - to register the subscription
 in the pub/sub subsystem.
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(java.lang.String presenceInfo)
             throws CollaborationException
presenceInfo - Presence information in XML format
CollaborationException
public void fetch(java.lang.String presentity,
                  PresenceInfoListener listener)
           throws CollaborationException
presentity - presentity referencelistener - callback object used by the provider to
 return search results
 asynchronously.
CollaborationException
public void fetch(java.lang.String[] presentity,
                  PresenceInfoListener listener)
           throws CollaborationException
presentity - array of presentity referenceslistener - callback object used by the provider to return
 search results asynchronously.
CollaborationException
public java.lang.String fetch(java.lang.String presentity)
                       throws CollaborationException
presentity - presentity url
CollaborationException
public java.lang.String[] fetch(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 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| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||