state[@type='aggregateState']
Specifies an aggregated presence 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="aggregateState"
manual="xs:boolean"
startTime="xs:dateTime"
majorVersion="xs:unsignedInt"
minorVersion="xs:unsignedInt"
[anyAttri]="anyAttribute">
lastActive="xs:dateTime"
<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>
aggregateState : 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. |
lastActive |
Optional attribute describing the date and time when the presence state was last active. This attribute is specific to the presence state category instance of the aggregateState type. |
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 |
---|---|---|
0 ore 1 |
Availability number indicating the presence status. |
|
0 or more |
An activity string and/or token describing the presence status. |
|
0 or 1 |
Location of the endpoint associated with this presence state |
|
0 or 1 |
Custom extension to the presence state |
|
0 or 1 |
Contains the meeting subject as specified in a calendar state category instance derived from the calendar data of the presentity. |
|
0 or 1 |
Contains the meeting location as specified in a calendar state category instance derived from the calendar data of the presentity. |
|
0 or 1 |
Contains the time zone bias from UTC in minutes of the local time zone where this publication is made. |
|
0 or 1 |
Contains the name of the local time zone where this publication is made. |
|
0 or 1 |
Contains the abbreviation of the local time zone where this publication is made. |
|
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:
|
|
0 or more |
A beginning marker of a schema extension to this element. |
|
[any] |
0 or more |
Schema extension |
0 or 1 |
The ending marker of all the schema extensions to this element. |
|
0 or 1 |
Application-specific custom extension. |
Parent Elements
Element |
Description |
---|---|
None |
This is a top-level element as an aggregated state category instance value. |
Text Value
None
Remarks
stateType is the base type of the aggregateState. Use stateType as the serialization type to serialize or de-serialize an aggregateState category instance.
Lync 2010 allows remote subscribers to receive this type of state category instances only.
Example
The following XML snippet shows an aggregated state category instance value.
<state xsi:type="aggregateState"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://schemas.microsoft.com/2006/09/sip/state">
<availability>3500</availability>
<endpointLocation>Building 10, Room 101, West Campus</endpointLocation>
<delimiter xmlns="https://schemas.microsoft.com/2006/09/sip/commontypes" />
<timeZoneBias>480</timeZoneBias>
<timeZoneName>Pacific Standard Time</timeZoneName>
<timeZoneAbbreviation>Pacific Standard Time</timeZoneAbbreviation>
<device>computer</device>
<end xmlns="https://schemas.microsoft.com/2006/09/sip/commontypes" />
</state>
The above presence state category instance value describes that the overall presence state is available (availability=3500) of a presentity located in Room 101 of Building 10 on West Campus situated in the US Pacific Standard Time zone.
Notice that a schema extension to this element is enclosed between the ct:delimiter and ct:end elements.
Element Information
Namespace |
https://schemas.microsoft.com/2006/09/sip/state |
Schema Name |
state |
Validation File |
state.xsd, statetypes.xsd |
Can be Empty |
True |
See Also
Other Resources
Presence State and state Category Instances