contactGroup Element
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.
When a contact or group is added, updated, or deleted, the client receives a contactGroup event that envelopes the details of the action on the contact group.
Syntax
<contactGroup eid="integer value" fullList="true|false" deltaNum="integer value"/>
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 |
|---|---|
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 |
Occurrences |
Description |
|---|---|---|
0 or more |
The group that has been added or updated in the users contact list. |
|
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, updates or deletes contacts or groups.
Other logon instances of the same user add, update or delete contacts or groups.
Examples
This event response indicates that the logged-on user has added one new contact group called "Softball Team", added one new contact assigned to the new group, and deleted one contact. It is not necessary to specify group membership for contacts deleted.
<contactGroup eid="1344" deltaNum="2" fullList="true">
<group name="Softball Team" id="1" action="added"/>
<contact uri="sip:jessicaa@contoso.com" name="..." subscribed="true"
tag="false" groups="1" action="added"/>
<contact uri="sip:jaya@contoso.com" action="deleted"/>
</contactGroup>