2.2.2.6.1 subscribers Document

  • Article

The subscribers document XML schema is as follows:

<xs:schema
    targetNamespace="http://schemas.microsoft.com/2006/09/sip/presence-subscribers"
    elementFormDefault="qualified" attributeFormDefault="unqualified"
    xmlns="http://schemas.microsoft.com/2006/09/sip/presence-subscribers"
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ContextType">
    <xs:sequence>
      <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="1"></xs:any>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="SubscriberType">
    <xs:sequence>
      <xs:element name="context" minOccurs="0" maxOccurs="1" type="ContextType"></xs:element>
    </xs:sequence>
    <xs:attribute name="user" type="xs:string" use="required"></xs:attribute>
    <xs:attribute name="displayName" type="xs:string" use="required"></xs:attribute>
    <xs:attribute name="acknowledged" type="xs:boolean" use="required"></xs:attribute>
    <xs:attribute name="type" use="optional">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="federated"></xs:enumeration>
          <xs:enumeration value="publicCloud"></xs:enumeration>
          <xs:enumeration value="sameEnterprise"></xs:enumeration>
          <xs:enumeration value="unknown"></xs:enumeration>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
  <xs:complexType name="SubscribersType">
    <xs:sequence>
      <xs:element name="subscriber" type="SubscriberType" minOccurs="0" maxOccurs="unbounded"></xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:element name="subscribers" type="SubscribersType"></xs:element>
</xs:schema>

The following is an example subscribers document:

<subscribers xmlns="http://schemas.microsoft.com/2006/09/sip/presence-subscribers">
  <subscriber  user="bob@contoso.com" 
               displayName="Bob" 
               acknowledged="false" 
               type="sameEnterprise"/>
</subscribers>

Elements and attributes of a subscribers document are defined in this section.

The XML elements of a subscribers document MUST conform to the schema defined in section 6.4

subscribers: This element is a wrapper for multiple subscriber elements.

subscriber: This element provides information about a subscriber. The attributes are the following:

  • user: The URI of the subscriber. This value MUST be a valid URI.

  • displayName: The display name of the subscriber. The server can use the display name received in the SUBSCRIBE request.

  • acknowledged: A Boolean value that shows whether the subscriber has been acknowledged by the publisher. A value of true denotes that the subscriber has been acknowledged by the publisher; false denotes that the subscriber has not been acknowledged.

  • type: This is an optional attribute. If the server can determine the source network for the incoming SUBSCRIBE request, it MAY provide this additional information. If supplied, the value is one of the following: "federated", "publicCloud", "sameEnterprise" and "unknown".

  • context: A copy of a context element in a SUBSCRIBE request from this subscriber.