Share via


st:state

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Represents a presence state.

Syntax

<st:state xmlns:st="http://schemas.microsoft.com/2006/09/sip/state" 
          manual="…" startTime="…" majorVersion="…" minorVersion="…" …>
   <st:availability>…</st:availability>
   <st:activity>…</st:activity>
   <st:extension>…</st:extension>
</st:state>

Attributes

Attribute Data Type Description

type

xsi:type

The type of the state instance. Possible values are "aggregateState", "aggregateMachineState", "userState", "machineState", "phoneState", and "calendarState".

xsi

xmlns:xsi

The location of the XMLSchma-instance namespace. The value must be "http://www.w3.org/2001/XMLSchema-instance".

xmlns

string

The namespace to which this element belongs. The value must be "http://schemas.microsoft.com/2006/09/sip/state".

manual

xs:boolean

Specifies whether the state is set manually (true) or not (false). The default value is false. Optional.

startTime

xs:dateTime

Starting time when the state became effective. Optional.

majorVersion

xs:unsignedint

Major version number of the schema format. Optional.

minorVersion

xs:unsignedint

Minor version number of the schema format. Optional.

lastActive

xs:dateTime

Specifies how long the user has been away. The time is in UTC. This attribute is used in instances of type aggregateState. Optional.

endpointId

xs:string

The GRUU of the device. This attribute is used in instances of type aggregateMachineState.

uri

xs:anyUri

The URI for the telephone. This attribute is used in instances of type phoneState and calendarState. Optional

Parent Element

This is a top-level element in the Enhanced Presence Schemas. In applications, this will be enveloped within an application-specific parent element.

Child Elements

Element Occurrence Description

st:availability

0 or more

Presence availability value.

st:activity

0 or more

User activity

st:extension

0 or 1

Used to contain zero or more any elements in the same namespace as an extension to the presence state.

st:endpointLocation

0 or 1

Supported only for the state elements of the machineState and aggregateState types.

st:meetingLocation

0 or 1

Supported only for the state elements of the calendarState and aggregateState types.

st:meetingSubject

0 or 1

Supported only for the state elements of the calendarState and aggregateState types.

Remarks