state

Article
03/15/2011

Specifies an aggregated machine state category instance.

<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="aggregateMachineState"
       manual="xs:boolean"
       startTime="xs:dateTime"
       majorVersion="xs:unsignedInt"
       minorVersion="xs:unsignedInt"
       [anyAttri]="anyAttribute"
       endpointId="xs:string">
   <st:availability>xs:unsignedInt</st:availability>
   <st:activity>st:activityType</st:activity>
   <st:endpointLocation>st:endpointLocationEnumEx</st:endpointLocation>
   <st:extension>st:extensionType</st:extension>
   <st:meetingSubject>st:LCIDType</st:meetingSubject>
   <st:meetingLocation>st:LCIDType</st:meetingLocation>
   <st:timeZoneBias>xs:long</st:timeZoneBias>
   <st:timeZoneName>xs:string</st:timeZoneName>
   <st:timeZoneAbbreviation>xs:string</st:timeZoneAbbreviation>
   <st:device>st:deviceTypeEnumEx</st:device>
   <ct:delimiter/>
   <st:[any]>any element</st:[any]>
   <ct:end/>
   <ct:extension>
     <[any] xmlns="any.namespace">...</[any]>
   </ct:extension>
</st:state>

aggregateMachineState : 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 "aggregateMachineState". 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.
endpointId	Required attribute identifying the device reachable for the given presence status.
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
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
state/meetingSubject	0 or 1	Contains the meeting subject as specified in a calendar state category instance derived from the calendar data of the presentity.
state/meetingLocation	0 or 1	Contains the meeting location as specified in a calendar state category instance derived from the calendar data of the presentity.
state/timeZoneBias	0 or 1	Contains the time zone bias from UTC in minutes of the local time zone where this publication is made.
state/timeZoneName	0 or 1	Contains the name of the local time zone where this publication is made.
state/timeZoneAbbreviation	0 or 1	Contains the abbreviation of the local time zone where this publication is made.
state/device	0 or 1	Contains the type of the device where this publication is made. Valid values are of the st:deviceTypeEnumEx tokens. Microsoft Lync 2010 recognizes the following device type tokens: computer The device is a computer on which Lync 2010 is running. deskphone The device is a desk phone on which Microsoft Lync 2010 Phone Edition is running. mobile The device is a mobile phone on which Microsoft Lync 2010 Mobile is running. web This is a computer on which Microsoft Lync Web App is running.
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 an aggregated machine state category instance value.

Text Value

None

Remarks

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

Lync 2010 does not allow remote subscribers to receive this type of state category instances.

Example

The following XML snippet shows an aggregated machine state category instance value.

<state xsi:type="aggregateMachineState" 
       endpointId="0e45e3d7-7959-5d3d-8a48-1362199b2263" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xmlns="https://schemas.microsoft.com/2006/09/sip/state">
   <availability>3500</availability>
</state>

The above presence state category instance value describes that the overall machine state as available (availability being 3500) and the corresponding device as identified by the endpointId value of 0e45e3d7-7959-5d3d-8a48-1362199b2263.

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