userProperties

Article
03/15/2011

Contains user properties received via in-band provisioning from the server.

<up:userProperties xmlns:up="https://schemas.microsoft.com/2006/09/sip/categories" 
       majorVersion="xs:unsignedInt" 
       minorVersion="xs:unsignedInt"
       [anyAttri]="anyAttribute">
   <up:lines>List of <up:line> elements </up:phones>
   <up:telephonyMode>telephonyMode token or string </up:telephonyMode>
   <up:fascimileTelephoneNumber>xs:token</up:fascimileTelephoneNumber>
   <up:streetAdress>xs:token</up:streetAddress>
   <up:l>xs:token<up:l>
   <up:st>xs:token</up:st>
   <up:countryCode>xs:token</up:countryCode>
   <up:postalCode>xs:token</up:postalCode>
   <up:wWWHomePage>xs:token</up:wWWHomePage>
   <up:exumEnabled>xs:unsignedLong</up:exumEnabled>
   <up:exumURL>xs:token</upexumURL>
   <up:forwardingUrls>List of any elements</up:forwardingUrls>
   <ct:delimiter xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" />
   <up:acpInformation>up:acpProvisionType</up:acpInformation>
   <ct:delimiter xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" />
   <[any]>any element</[any]>
   <ct:end xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" />
   <ct:extension xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" >...<ct:extension>
</up:userProperties>

userPropertiesType

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
majorVersion	Optional attribute to specify schema-dependent major version information. The default value is unspecified.
minorVersion	Optional attribute to specify schema-dependent minor version information. The default value is unspecified.
[anyAttr]	Optional custom attribute of any name and namespace.

Child Elements

Element	Occurrence	Description
userProperties/lines	0 or 1	An element of the xs:element type containing a list of the userProperties/lines/line elements specifying the list of phone lines controlled by the user.
up:telephonyMode	0 or 1	A token of the up:telephonyModeEnumEx type to specify the telephony mode of the user. Microsoft Lync 2010 recognizes the following telephony modes: None Telephony is not enabled. Uc The user has a VoIP phone. Rcc The user has a RCC phone. Dual The user can make VoIP and RCC calls.
up:facsimileTelphoneNumber	0 or 1	A token of the xs:token type to specify the fax number of the user.
up:streetAddress	0 or 1	A token of the xs:token type to specify the street address of the user.
up:l	0 or 1	A token of the xs:token type to specify the city name of the user.
up:st	0 or 1	A token of the xs:token type to specify the name of state or province of the user.
up:countryCode	0 or 1	A token of the xs:token type to specify the country code of the user.
up:postalCode	0 or 1	A token of the xs:token type to specify the zip code or postal code of the user.
up:wWWHomePage	0 or 1	A token of the xs:token type to specify the website of the user.
up:exumEnabled	0 or 1	A bit flag of the xs:unsignedLong type to indicate whether voicemail is enabled for the user (0x0001) or not (otherwise).
up:exumURL	0 or 1	A token of the xs:token type to specify the Exchange Unified Messaging URL for the user.
up:forwardingUrls	0 or more	A sequence of any elements in the same namespace specifying the URLs to which incoming calls are forwarded.
userProperties/acpInformation	0 or 1	An element of the acpProvisionType type specifying the audio conference provider (ACP) information for the user.
delimiter	0 or more	A beginning marker of a schema extension to this element.
[any]	0 or more	Any element of the same namespace as a schema extension.
end	0 or 1	The ending marker of all the schema extensions to this element.
extension	0 or 1	Application-specific custom extension.

Parent Elements

Element	Description
None	This is a top-level element as a userProperties category instance value.

Text Value

None

Remarks

Lync publishes the userProperties category instance to the Self container only.

Example

The following XML snippet shows a userProperties category instance value.

<userProperties xmlns="https://schemas.microsoft.com/2006/09/sip/categories">
   <lines>
      <line lineType="Uc">tel:+1421112222;ext=12222</line>
   </lines>
   <telephonyMode>Uc</telephonyMode>
   <exumEnabled>1</exumEnabled>
   <exumURL>EUM:john@contoso.com;phone-context=EX-OCS-SIPSec.exchange.contoso.com</exumURL>
</userProperties>

Element Information

Namespace	https://schemas.microsoft.com/2006/09/sip/categories
Schema Name	userProperties
Validation File	userProperties.xsd
Can be Empty	True

Share via