subscribePresence 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.

Represents a request to subscribe to the presence of one or more users. To subscribe means to create a request for the current presence information of a contact that persistd for the life of the current Unified Communications session.

Syntax

<subscribePresence rid="19">
</subscribePresence> 

Attributes

Attribute

Data Type

Description

Rid

string

Request Id. This is a string value assigned by the Unified Communications client. This is a required attribute.

Element Information

Parent Element

Element

Description

cwaRequests

Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access server.

Child Elements

Element

Occurrences

Description

uris

1

A list of URI values.

Remarks

Whereas querying for a users presence returns a single snapshot of the current presence of the queried user, subscribing to a user presence returns the current presence of a user for the life of the current Unified Communications session. A permanent subscription can be created for a remote user by a direct subscription. If the client is configured to automatically subscribe contacts, adding a user to the local contact list subscribes. A legacy user must be added to the contact list to subscribe.

A subscription to the presence of a user results in SIP traffic whenever the subscribed user updates her presence. A mobile device application that is concerned about bandwidth might choose to query the presence of a user at the time the mobile device user wants to interact with a remote user. Doing this results in an overall reduction in bandwidth usage.

Examples

The logged-on user is subscribing to the presence of Jay Adams. The depth of presence information returned in this event response depends on the presence access level Jay Adams. has assigned to the logged-on user. If users have the public (100) level of presence access, they get the emailAlias and displayName in return. For an in-depth discussion of presence access levels, see Publishing and Subscribing to Presence.

<subscribePresence> 
   <uris>
      <uri>SIP:Jaya@contoso.com</uri>
   </uris>
</subscribePresence>

See Also

Concepts

queryPresence Element

unsubscribePresence Element