state/activity element

Applies to: Lync 2013 | Lync Server 2013

Describes an activity associated with the accompanying availability mode.

<st:activity xmlns:st="http://schemas.microsoft.com/2006/09/sip/state" 
       toekn="st:activityTokenEnumEx"
       maxAvailability="st:unsignedInt" 
       minAvailability="st:unsignedInt" 
       [anyAttri]="anyAttribute">
   <ct:delimiter xmlns:ct="http://schemas.microsoft.com/2006/09/sip/commontypes" />
   <[any]>any element</[any]>
   <ct:end xmlns:ct="http://schemas.microsoft.com/2006/09/sip/commontypes" />
   <ct:extension xmlns:ct="http://schemas.microsoft.com/2006/09/sip/commontypes" >...<ct:extension>
</st:state>

activityType

Attributes and elements

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

Attributes

Attribute	Description
token	Optional attribute to specify an activity token of the activityTokenEnumEx type as a supplemental description of the given availability mode. Microsoft Lync 2013 recognizes the following tokens: on-the-phone The presentity is on the phone. When no valid custom activity string is supplied, Lync 2013 displays the standard activity string of "On the phone". in-a-conference The presentity is in a conference. When no valid custom activity string is supplied, Lync 2013 displays the standard activity string of "In a conference". in-a-meeting The presentity is in a meeting. When no valid custom activity string is supplied, Lync 2013 displays the standard activity string of "In a meeting". out-of-office The presentity is out of office. When no valid custom activity string is supplied, Lync 2013 displays the standard activity string of "Out of office". urgent-interruptions-only The presentity wishes not to be disturbed except for urgent interruptions. When no valid custom activity string is supplied, Lync 2013 displays the standard activity string of "Urgent interruptions only. off-work The presentity is off work. Lync 2013 supplies a corresponding custom activity string of "Off work". Here, being off work is just another form of being away.. in-presentation The presentity is in the PRESENT mode of sharing using Microsoft Lync 2013. Lync 2013 supplies a corresponding custom activity string of "Presenting". A presenting state is another Do Not Disturb state.
maxAvailability	Optional attribute to specify the maximal availability mode associated with this activity description. The default value is unbounded.
minAvailability	Optional attribute to specify the minimal availability mode associated with this activity description. The default value is 0.
[anyAttr]	Optional custom attribute of any name and namespace.

Child elements

Element	Occurrence	Description
custom	0 or more	Specifies application-provided locale-specific activity string. This element is of the LCIDType defined in the same namespace.
delimiter element	0 or more	A beginning marker of a schema extension to this element.
[any]	0 or more	Schema extension
end element	0 or 1	The ending marker of all the schema extensions to this element.
extension element	0 or 1	Application-specific custom extension.

Parent elements

Element	Description
state category instance value elements	A presence state category instance value.

Text value

None

Remarks

Multiple occurrences of the custom element can be specified to support multiple locale-specific versions of the same custom activity string.

Example

The following XML example shows a userState category instance value containing an availability number of 15500 to indicate the Out of Office status and a custom activity string of "Away at an off-site".

<state xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xmlns:xsd="http://www.w3.org/2001/XMLSchema"
       xsi:type="userState" 
       xmlns="http://schemas.microsoft.com/2006/09/sip/state">
   <availability>15500</availability>
   <activity>
      <custom LCID="1033">Away at an off-site</custom>
   </activity>
</state>

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

Element information

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

See also

Reference

Category instance elements for presence

state category instance value elements

Other resources

Presence State and state Category Instances