presenceSubscriptionState Element

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.

Includes a pending or completed list of URIs to which the logged-on user is subscribed.

Syntax

<presenceSubscriptionState eid="integer value"/> 

Element Information

Parent Element

Element

Description

cwaEvents

Holds the responses from the asynchronous data channel with which a Unified Communications AJAX API Client polls the server for updates that have taken place.

Child Element

Element

Description

user

The user who has been subscribed to.

Remarks

This element provides the current status of a presence subscription refresh. The Communicator Web Access server refreshes the client user presence cache by sending an up-to-date userPresence element for each subscribed user. The presenceSubscriptionState Element contains a user element for each user for whom presence is being refreshed. The user element attribute state can have three possible values: terminated, retrying and subscribed. When a user element state attribute value is subscribed, the Communicator Web Access server has filled the userPresence element for that user with current presence data. A state of retrying indicates the server did not retrieve the presence information for the user and is continuing to attempt to send updated information. This can happen when the logged-on user has been moved to a presence category with less access privilege. For example, Jim Hance has logged on to Unified Communications. His contact list includes Rajesh Patel. Rajesh has recently changed jobs and is no longer in the same enterprise as Jim. Jim is not aware of this and expects to be able to see Rajesh's presence information. Rajesh has moved Jim out of his Company container and into his Public container as is appropriate in this situation. Rajesh has chosen not to publish his presence outside of his new organization. Rajesh is still a valid user but no presence information is being returned to Jim. Until Jim cancels his subscription to Rajesh's presence using the unSubscribePresence request, the Communicator Web Access server continues to attempt to update Rajesh's presence in Jim's contact list.

Examples

<presenceSubscriptionState eid="9">
   <user uri="sip:xxx@contoso.om" state="terminated"/>
   <user uri="sip:xxx@contoso.om" state="retrying"/>
   <user uri="sip:MannyP@contoso.com" state="subscribed"/>
   <user uri="sip:ArthurH@contoso.com" state="subscribed"/>
</presenceSubscriptionState>

See Also

Concepts

subscribePresence Element