contactGroup 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.

Describes the operations performed on a list of contacts or contact groups resulting from requests made by the Unified Communications AJAX API Client application user.

This release of Communicator Web Access generates a contactGroupChanged element. When a contact or group is deleted, a contact or group element is created with an action attribute set to delete. The general release of Communicator Web Access uses the syntax in "Examples."

Syntax

<contactGroup eid="1344" fullList="true|false" deltaNum="integer value">
   <group name="..." externalUri="..."/>
   <contact uri="sip:jessicaa@contoso.com" name="..." subscribed="true"
      tag="false"/>
</contactGroup>

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
fullList	Boolean	Indicates a full list of contacts and groups is provided with this group event. If the value is true, the list is a snapshot of user's contact and group data. If false, the list includes only updated items.
deltaNum	integer	Indicates this event reflects a change to the contactGroup.

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
group	0 or more	The group that has been added or updated in the users contact list.
contact	0 or more	The contact that has been added or updated in the users contact list.

Remarks

The contactGroup event indicates any change to the contact and group list. Unified Communications AJAX API Client receives a contactGroup event in the following situations:

When the application first logs on the user, in which case, the contactGroup event contains the snapshot of all the contacts and groups of the user.
When the application adds or deletes contacts or groups.
Other logon instances of the same user add or delete contacts or groups.

Examples

XML example of the event

This event response indicates that the logged-on user has one contact group (Softball Team), one contact who is a member of that group, and one contact who has been deleted.

<contactGroup eid="1344">
   <group name="Softball Team" id="1"/>
   <contact uri="sip:jessicaa@contoso.com" name="..." subscribed="true"
      tag="false" groups="1"/>
</contactGroup>

Share via