group Element [Unified Communications AJAX SDK]

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 a user-defined group.

Syntax

<group id="integer value" name="string value" externalUri="string value"/>

Attributes

Attribute	Data Type	Description
Action	string	This optional attribute is present when the contact element is present as a child of contactGroup. The attribute is a verb representing the action performed on the contact. The possible values are added \| updated \| deleted
Id	integer	The integer id for the group to perform the action on. This is a required attribute for updateGroup and deleteGroup requests.
Name	string	The name of the group. This is a required attribute except for delete group requests.
externalUri	xs:anyUri	A string specifying uri details for this group. Used during Distribution Group Expansion. When adding a distribution group, you should include this attribute.

Element Information

Parent Element

Element	Description
updateGroup	Updates a contact group.
addGroup	Creates a contact group.
deleteGroup	Deletes a contact group.
contactGroup	Describes the operations performed on a list of contacts or contact groups.

Remarks

This element is a multi-purpose element. When the element is a child of contactGroup, it is returning existing groups to the Unified Communications AJAX API Client application. When it is a child of the updateGroup, addGroup, or deleteGroup request it specifies the group to perform the requested action on. The name and externalUri attributes are only required for add and update operations on Microsoft Exchange Distribution Groups. If you are creating a personal group, you do not need to specify externalUri. The first time a user logs on to an Office Communicator Server, no contact groups exist. The client must create a contact group with the name attribute of '~'. This special group holds all contacts not assigned to other groups.

Examples

This example is part of a larger XML tree fragment received from the data channel asynchronously when a user logs on. This user has four contact groups and three contacts in their permanent list. Because this information is not stored locally on a client computer, the initateSession method returns all this data to the client.

<contactGroup eid="1" fullList="true">
<group id="2" name="Football Players" externalUri="" action="added"/>
<group id="3" name="Baseball Players" externalUri="" action="updated"/>
<group id="4" name="Atheletes" externalUri="" action="updated">
<group id="5" name="Superman" externalUri="" action="updated">
<contact uri="sip:..." name="Ben Smith" groups="2 3" subscribed="true" tag="true" />
<contact uri="sip:..." name="Patrick Sands" groups="3 4" subscribed="true" tag="true" />
<contact uri="sip:..." name="Thomas Andersen" groups="4 5"  subscribed="true" tag="true" />
</contactGroup>

Share via