state[@type='userState']

Specifies an enhanced presence user state category instance value.

<st:state xmlns:st="https://schemas.microsoft.com/2006/09/sip/state" 
       type="userState"
       manual="xs:boolean" 
       startTime="xs:dateTime" 
       majorVersion="xs:unsignedInt" 
       minorVersion="xs:unsignedInt"
       [anyAttri]="anyAttribute">
   <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" />
   <[any] xmlns="https://schemas.microsoft.com/2006/09/sip/state">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" >
      <[any] xmlns="any.namespace">...</[any]>
   <ct:extension>
</st:state>

userState : 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 userState. 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.

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 user state category instance value.

Text Value

None

Remarks

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

Microsoft Lync 2010 publishes a use state category instance when the user sets his or her presence availability using the Lync 2010 user-interface.

Example

The following XML snippet shows user state category instance value.

<state xmlns="https://schemas.microsoft.com/2006/09/sip/state" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       manual="true" 
       xsi:type="userState">
    <availability>3500</availability>
</state>

This user state category instance shows that the user’s presence status is available (3500).

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