subscribers Event
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.
Returns the list of subscribers to the Unified Communications AJAX API Client application users presence.
Syntax
<subscribers eid="1344">
<subscriber uri="jessicaa@contoso.com" displayName="Jessica" sourceNetwork="domain"
acknowledged="true"/>
</subscribers>
The following sections describe attributes, parent elements, and child elements.
Attributes
Attribute |
Data Type |
Description |
|---|---|---|
eid |
integer |
Event Id. This is an integer value assigned by the Communicator Web Access Server. |
Element Information
Parent Element
Element |
Description |
|---|---|
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 |
Occurrence |
Description |
|---|---|---|
1 or more |
The user that has subscribed to receive presence. |
Remarks
The subscribers element provides a list of other users who have subscribed to the presence of the local user. The local user receives this element on the data channel immediately after a remote user has requested a subscription to the local user's presence. If the local user is not online at the time of the subscription request, the subscribers element is sent following the next successful local user logon. The individual subscriber child elements represent the remote users who have subscribed to the local user's presence but have not been acknowledged by the local user.
To acknowledge a remote user's subscription request, the acknowledgeSubscriber request is made. Each individual subscriber to be acknowledged is added as an uri element.
The subscribers element is returned to the Unified Communications AJAX API Client application asynchronously on the data channel following a successful initateSession request. The element contains a list of all users who are currently subscribing to the logged-on users presence.
Examples
<subscribers eid="5">
<subscriber user="john@contoso.com"
displayName="John"
acknowledged="false"
type="sameEnterprise" />
</subscribers>