state

Article
03/15/2011

Specifies an enhanced presence phone state category instance value.

<st:state xmlns:st="https://schemas.microsoft.com/2006/09/sip/state" 
          xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:type="phoneState"
       manual="xs:boolean" 
       startTime="xs:dateTime" 
       majorVersion="xs:unsignedInt" 
       minorVersion="xs:unsignedInt"
       [anyAttri]="anyAttribute"
       uri="anyURI">
   <st:availability>xs:unsignedInt</st:availability>
   <st:activity>st:activityType</st:activity>
   <st:endpointLocation>st:endpointLocationEnumEx</st:endpointLocation>
   <st:extension>st:extensionType</st:extension>
   <ct:delimiter xmlns:ct="https://schemas.microsoft.com/2006/09/sip/commontypes" />
   <st:[any]>any element in the state namespace</st:[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" >
      <[any] xmlns="any.namespace">...</[any>
   </ct:extension>
</st:state>

phoneState : stateType

Attributes and Elements

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

Attributes

Attribute	Description
xsi:type	Required attribute with the fixed value of phoneState. This attribute is not explicitly defined, but permitted as one of any custom attributes (@[anyAttr]) described below.
manual	Optional attribute to specify if the publication of this state is manual (true) or not (false). The default value is false.
startTime	Optional attribute to specify the starting time of this state publication. The default value is unspecified.
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.
uri	Optional attribute to specify the TEL URI of the phone.

Child Elements

Element	Occurrence	Description
availability	0 ore 1	Availability number indicating the presence status.
activity	0 or more	An activity string and/or token describing the presence status.
endpointLocation	0 or 1	Location of the endpoint associated with this presence state
endpointLocation	0 or 1	Custom extension to the presence state
delimiter	0 or more	A beginning marker of a schema extension to this element.
[any]	0 or more	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 phone state category instance value.

Text Value

None

Remarks

stateType is the base type of the phoneState. Use stateType as the serialization type to serialize or de-serialize a phoneState category instance.

Microsoft Lync 2010 publishes a phone state when an audio or video call is established.

Example

The following XML snippet shows a phone state category instance value describing a conference call is under way.

<state xmlns="https://schemas.microsoft.com/2006/09/sip/state" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       manual="false" 
       xsi:type="phoneState">
    <availability>7000</availability>
    <activity token="in-a-conference" minAvailability="7000" maxAvailability="8999" />
</state>

Element Information

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

Share via