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

Updates the setting of a contact.

Syntax

<updateContact rid="string value"></updateContact>

Attributes

Attribute	Data Type	Description
Rid	string	Request Id. This is a string value assigned by the Unified Communications client. This is a required attribute.

Element Information

Parent Element

Element	Description
cwaRequests	Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access server.

Child Elements

Element	Occurrences	Description
Contact	1	A person in a contact list. The attribute values indicate subscription and tag status. In addition, the groups that the contact has been assigned to are listed.

Remarks

This request allows the Unified Communications AJAX API Client application to update a user in their contact list. The Communicator Web Access server responds synchronously on the command channel and asynchronously on the data channel. The asynchronous event response holds an updated list of the logged-on users contacts. The attributes of the contact that are included in this request are updated with the specified values. For the attributes that are not included in this request, the Communicator Web Access Server updates the attributes with their default values. The Communicator Web Access Server places default values in attributes not specified in the update request. If adding the contact to an additional contact group, the complete list of all groups you want them to be a member of must be provided.

Note

If the groups attribute of the contact element is included in this request, the attribute must not be empty. An empty attribute effectively removes the contact from all contact groups including the default "All Contacts" group. If the user interacts with their contact list using the Office Communicator UI, this updated contact does not appear in the contact list and cannot be restored to the list.

Examples

This request updates the contact name, subscription status, tag, and group membership. If the contact was a member of the group with Id = 2 before this request, the contact is added to the membership of group 3.

<updateContact rid="100">
   <contact uri="sip:alice@contoso.com" name="alice" subscribed="true"
   tag="false" groups="2 3" />
</updateContact>

Share via