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

A user and his category data.

Syntax

<user uri="SIP Uri formatted string" sourceNetwork="string value" iconUri="string value"></user>

Attributes

Attribute	Data Type	Description
Uri	xs:anyUri	The SIP URI of the user to which this category belongs. This is a required attribute.
sourceNetwork	cwa:CwaSourceNetwork (string)	The source location of the user. Possible values are domain, sameEnterprise, publicCloud, federated. This attribute is available in userPresence event.
State	integer	Available in presenceSubscriptionState. Indicates a user availability state.
iconUri	xs:anyUri	The URI where the user's icon is located. The client can download the remote user icon file and display in a custom contact list. This attribute is filled when user is a federated or public cloud user. The icon represents the image associated with the source network.

Element Information

Parent Element

Element	Description
userPresence	Envelope for receiving the contact users presence categories.
presenceSubscriptionState Element	Includes a pending-or-completed list of URIs, to which the logged-on user is subscribed.

Child Elements

Element	Occurrences	Description
cwaCategory	1 or more	The category data of the user.
any	0 or more	User-defined element. Any element from the namespace specified in the namespace attribute is acceptable. The namespace must not be the namespace of the Unified Communications schema.
rawCategory	0 or more

Remarks

This element can be returned in two separate contexts. When the element is returned as a part of a userPresence event, user contains category presence data. When it is returned as child of presenceSubscriptionState,it only contains the URI of the user.

Examples

In this example, user only contains a URI.

<presenceSubscriptionState eid="8">
   <user uri="sip:jessicaa@contoso.com" state="subscribed" />
</presenceSubscriptionState>

In this example, user contains presence category information.

   <userPresence eid="9">
     <user uri="sip:jessicaa@contoso.com" sourceNetwork="sameEnterprise">
        <cwaCategory name="calendarData" instance="0" />
        <cwaCategory name="contactCard" instance="0">
           <contactCard xmlns=".../contactcard">
              <identity>
                 <name>
                    <displayName>jessa</displayName>
                 </name>
              </identity>
           </contactCard>
        </cwaCategory>
        <cwaCategory name="contactCard" instance="1">
           <contactCard xmlns=".../contactcard">
             <phone type="work">
                <uri>tel:</uri>
                <displayString></displayString>
             </phone>
             <phone type="mobile">
               <uri>tel:</uri>
               <displayString></displayString>
             </phone>
           </contactCard>
        </cwaCategory>
        <cwaCategory name="contactCard" instance="3">
           <contactCard xmlns="...contactcard">
              <company></company>
              <title></title>
              <office></office>
           </contactCard>
        </cwaCategory>
        <cwaCategory name="note" instance="0">
          <note xmlns="...note">
             <body type="personal">Jay As personal note</body>
          </note>
        </cwaCategory>
        <cwaCategory name="state" instance="0">
           <state xsi:type="aggregateState" xmlns:xsi="...XMLSchema-instance" xmlns="...state">
              <availability>3500</availability>
           </state>
        </cwaCategory>
     </user>
   </userPresence>