cwaEvents Element

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.

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.

Syntax

<cwaEvents sid="integer value" pollWaitTime="integer value" ackId="integer value" sesionTimeout="integer value"/>

Attributes

Attribute	Data Type	Description
sid	integer	Session Id. This is an integer value assigned by the Communicator Web Access Server. It is returned to the client as a synchronous response to the initiateSession request.
ackId	integer	This is the id of the last event returned to the client along the data channel prior to the present cwaEvents response. For this release, lastEventId is named ackId.
pollWaitTime	integer	The time in milliseconds before the Unified Communications AJAX API Client application can GET another batch of events from the data channel.
sessionTimeout	integer	Session timeout value. Indicates how long until a session times out if no user activity is detected. This is set by a Communicator Web Access Server

Element Information

Child Elements

Element	Occurrences	Description
requestSucceeded	1 or more	Indicates a request has been successfully processed.
requestFailed	1 or more	Contains diagnostic error information when the server failed to process a request.
contactGroup	1 or more	Describes the operations performed on a list of contacts or contact groups.
subscribers	1 or more	Returns a list of subscribers.
conference	1 or more	Groups conference-related events.
containers	1 or more	Returns a list of containers, with a full list of the membership for each container.
selfPresence	1 or more	Contains the logged-on users presence information
userPresence	1 or more	Envelope for receiving the presence category of other users.
selfRawCategories	1 or more	Envelope for receiving the users presence categories.
userRawCategories	1 or more	Envelope for receiving the presence category of other users.
configuration	1 or more	Contains changes in policy configured in the WMI policy store of the Communicator Web Access server.
searchResults	1 or more	Returns a query result: zero or more users.
voIPReceived	1 or more	Represents an invitation to join a VoIP conversation
voIPTerminated	1 or more	Indicates that a VoIP invitation has been terminated

Remarks

The polling uses HTTP GET requests. The updates can be the result of prior method calls submitted using the AJAX API requests, changes made by caller's contacts, or modifications entered in the client's other devices or endpoints. A Communicator Web Access server returns events about the process status for all the received requests. Such status events are as follows:

requestSucceeded: This event indicates that the Communicator Web Access server has successfully finished processing the request. For example, terminateSession. This request is carried out and could finish successfully synchronously.
requestFailed Event: This event indicates that the request failed due to an error.

For more information, see HTTP Communication.

The session timeout mechanism is meant to protect user privacy in a public computer scenario. For example: If a user leaves a public computer without logging out of a session, the Communicator Web Access Server times out the session. User activity on a client causes the server to reset the session timeout value.

Examples

<cwaEvents pollWaitTime="3000" sid="768" lastEventId="202">
   <contactGroup eid="2">
      <group id="1" name="family" />
      <group id="2" name="friends"/>
      <groupDeleted id="3" />
      <contact uri="jessicaa@contoso.com" name="Jay A."
         subscribed="Yes" tag="Tag" groups="10 12"/>
      <contactDeleted uri="sip:bob@contoso.com" />
   </contactGroup>
   <containers" eid="3">
      <container id="400">
         <member type="domain" value="contoso.com" />
      </container>
   </containers>
   <subscribers eid="4">
      <subscriber uri="sip:alice@contoso.com" acknowledged="true"
         sourceNetwork="sameEnterprise"/>
   </subscribers>
   <requestSucceeded eid="5" rid="1" />
   <userPresence eid="6">
      <user uri="sip:alice@contoso.com" "sameEnterprise"
         iconUri="">
         <cwaCategory name="workCategory" instanceMask="1"
            effectiveAt="2006-11-16T18:47:13"/>
      </user>
   </userPresence>
</cwaEvents>