userPresence Event

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Returns the presence or option information for a specified user.

Syntax

<userPresence eid="integer value"></userPresence>

The following sections describe attributes, parent elements, and child elements.

Attributes

Attribute	Data Type	Description
eid	integer	Event Id. This is an integer value assigned by the Communicator Web Access Server.

Element Information

Parent Element

Element	Description
cwaEvents	Holds the responses from the asynchronous data channel with which a Unified Communications AJAX API Client polls the server for updates that have taken place.

Child Elements

Element	Occurrence	Description
user	1 or more	The user and his list of category data.

Remarks

This envelope returns the presence data that was requested by the queryPresence request. The requesting user gets presence information according to their presence level as assigned by the queried user.

Examples

The presence information for Jay A. was queried using the queryPresence request. From the response, you can see that Jay A. is offline. The cwaCategorystate indicates that the availability of the user is zero (0), which corresponds to offline. In addition to receiving state information, the event response contains the note text designated by Jay A. for his presence status as well as his display name.

   <userPresence eid="10">
      <user uri="sip:jessicaa@contoso.com" sourceNetwork="sameEnterprise">
         <cwaCategory name="state" instanceMask="0">
            <state xmlns=".../sip/state" xmlns:xsi=".../XMLSchema-instance" xsi:type="aggregateState">
               <availability>0</availability>
               <activity token="Offline" />
            </state>
         </cwaCategory>
         <cwaCategory name="note" instanceMask="0">
            <note xmlns=".../sip/note">
               <body type="personal" />
            </note>
         </cwaCategory>
         <cwaCategory name="contactCard" instanceMask="0">
            <contactCard xmlns=".../sip/contactcard">
               <identity>
                  <name>
                     <displayName>Jay A.</displayName>
                  </name>
               </identity>
            </contactCard>
         </cwaCategory>
      </user>
   </userPresence>

Share via