complexType "subscriptionType"
Namespace:
http://schemas.microsoft.com/hs/2001/10/core
Content:
complex, 3 attributes, 4 elements
Defined:
globally in hscommon.xsd; see XML source
Includes:
definitions of 4 elements
Used:
at 14 locations
XML Representation Summary
<...
   
 = 
xsd:nonNegativeInteger
 = 
xsd:hexBinary
 = 
xsd:string
   
>
   
Content: 
</...>
Content Model Elements (4):
context (defined in subscriptionType complexType), expiresAt (type xsd:dateTime), to (type xsd:anyURI), trigger (defined in subscriptionType complexType)
All Direct / Indirect Based Elements (14):
subscription, subscription (in myApplicationSettings), subscription (in myCalendar), subscription (in myCategories), subscription (in myContacts), subscription (in myDevices), subscription (in myDocuments), subscription (in myFavoriteWebSites), subscription (in myInbox), subscription (in myLocation), subscription (in myPresence), subscription (in myProfile), subscription (in myWallet), subscription (type subscriptionType)
Known Usage Locations
Annotation
This element defines a subscription node that is designed to be an <b>xdb:blue</b> node which, when placed in a content document, causes a subscription to be registered. A subscription contains a trigger element which selects a scope of coverage. When items change that are under this scope of coverage, and <b>subscriptionResponse</b> message is generated and sent to the specified destination address.
XML Source (see within schema source)
<xsd:complexType name="subscriptionType">
<xsd:annotation>
<xsd:documentation>
This element defines a subscription node that is designed to
be an
<b>xdb:blue</b>
node which, when placed in a content document, causes
a subscription to be registered. A subscription contains a trigger element
which selects a scope of coverage. When items change that are under this scope
of coverage, and
<b>subscriptionResponse</b>
message is generated and sent to the specified
destination address.
</xsd:documentation>
<xsd:appinfo>
<xdb:system type="subscription"/>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<!--
//
// a subscription contains
// - trigger which specifies the data that will
// trigger a notification
// - an expiration time after which the subscription
// will expire and automatically be removed from the
// document
// - context which is transmitted when this subscription is triggered
// - a location to send the subscription message to
-->
<xsd:element name="trigger">
<xsd:complexType>
<xsd:attribute name="select" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This item specifies an XPath expression that specifies the nodes that are
to be selected and watched for changes. The selection may select only
<b>xdb:blue</b>
nodes. As changes in this node set occur, they
trigger the generation of subscription messages. These messages are then sent
to the SOAP receiver listed in the
<b>to</b>
element.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="mode" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies whether the content of the changes
that triggered the subscription are delivered in the subscription
message, or the message simply indicates that something changed
under the trigger. The attribute may be:
<dl>
<dt>
<b>includeData</b>
</dt>
<dd>
The data that changed, causing the subscription to trigger, is
included in the subscription message. Note that deleted nodes
are specified by their ID, not by value.
</dd>
<dt>excludeData</dt>
<dd>
The data that changed, causing the subscription to trigger, is
not included in the subscription message.
</dd>
</dl>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="string">
<xsd:enumeration value="includeData"/>
<xsd:enumeration value="excludeData"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="baseChangeNumber" type="changeNumberType" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the
<b>changeNumber</b>
value to which the trigger relates. All changes between the specified change number and the current state
of the document relative to the selection are transmitted as subscription
messages. This allows a client application to establish a subscription
relative to some baseline. As with
<b>changeQuery</b>
, if the
<b>baseChangeNumber</b>
is
way out of date relative to the current state of the document, and the service
can not supply the changes in the subscription message, the subscription
insert is rejected. A value of zero means that the current values of
the selected nodes are transmitted in the subscription message.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="expiresAt" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
This optional element specifies an absolute time after which the
subscription is no longer active. The
<b>subscription</b>
node is
automatically removed when the subscription expires. If this element
is missing, the subscription does not expire.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="context">
<xsd:annotation>
<xsd:documentation>
This element returns the
<b>context</b>
element from the original
subscription. Applications should use this element and only this element
to correlate the subscription response with one of their subscriptions.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="uri" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the URI value chosen by the subscriber
that is associated with this subscription.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="to" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the location that is to receive the subscription
message. The value of this element may be one of the following forms:
<ul>
<li>
<b>hs:myAlerts</b>
This URI indicates that generated subscription
messages are to be delivered inside the body of a notification and delivered
to the default .NET Alerts service of the creator.
</li>
<li>
<b>protocol://service</b>
This URI indicates that generated subscription
messages are delivered to the specified service at the domain of the creator's
<b>platformId</b>
. For instance, a
<b>platformId</b>
indicating contoso.com, and a value in this
element of http://subscriptionResponse, would cause delivery of the subscription
message to http://subscriptionResponse.contoso.com.
</li>
</ul>
If this value is not specified, the subscription message is
delivered as a notification to the "creator's" .NET Alerts service.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="standardBlueAttributeGroup"/>
</xsd:complexType>
Attribute Detail (all declarations; 3/3)
changeNumber
Type:
changeNumberType
Use:
required
Defined:
locally within standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="changeNumber" type="changeNumberType" use="required"/>
creator
Type:
creatorType
Use:
required
Defined:
locally within standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="creator" type="creatorType" use="required"/>
id
Type:
idType
Use:
required
Defined:
locally within standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="id" type="idType" use="required"/>
Content Element Detail (all declarations; 4/4)
context
Type:
anonymous complexType, complex content
Defined:
locally within (this) subscriptionType complexType
This element returns the <b>context</b> element from the original subscription. Applications should use this element and only this element to correlate the subscription response with one of their subscriptions.
XML Source (see within schema source)
<xsd:element name="context">
<xsd:annotation>
<xsd:documentation>
This element returns the
<b>context</b>
element from the original
subscription. Applications should use this element and only this element
to correlate the subscription response with one of their subscriptions.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="uri" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the URI value chosen by the subscriber
that is associated with this subscription.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
expiresAt
Type:
xsd:dateTime, predefined, simple content
Defined:
locally within (this) subscriptionType complexType
This optional element specifies an absolute time after which the subscription is no longer active. The <b>subscription</b> node is automatically removed when the subscription expires. If this element is missing, the subscription does not expire.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="expiresAt" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
This optional element specifies an absolute time after which the
subscription is no longer active. The
<b>subscription</b>
node is
automatically removed when the subscription expires. If this element
is missing, the subscription does not expire.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
to
Type:
xsd:anyURI, predefined, simple content
Defined:
locally within (this) subscriptionType complexType
This attribute specifies the location that is to receive the subscription message. The value of this element may be one of the following forms: <ul> <li> <b>hs:myAlerts</b> This URI indicates that generated subscription messages are to be delivered inside the body of a notification and delivered to the default .NET Alerts service of the creator. </li> <li> <b>protocol://service</b> This URI indicates that generated subscription messages are delivered to the specified service at the domain of the creator's <b>platformId</b>. For instance, a <b>platformId</b> indicating contoso.com, and a value in this element of http://subscriptionResponse, would cause delivery of the subscription message to http://subscriptionResponse.contoso.com. </li> </ul> If this value is not specified, the subscription message is delivered as a notification to the "creator's" .NET Alerts service.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="to" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the location that is to receive the subscription
message. The value of this element may be one of the following forms:
<ul>
<li>
<b>hs:myAlerts</b>
This URI indicates that generated subscription
messages are to be delivered inside the body of a notification and delivered
to the default .NET Alerts service of the creator.
</li>
<li>
<b>protocol://service</b>
This URI indicates that generated subscription
messages are delivered to the specified service at the domain of the creator's
<b>platformId</b>
. For instance, a
<b>platformId</b>
indicating contoso.com, and a value in this
element of http://subscriptionResponse, would cause delivery of the subscription
message to http://subscriptionResponse.contoso.com.
</li>
</ul>
If this value is not specified, the subscription message is
delivered as a notification to the "creator's" .NET Alerts service.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
trigger
Type:
anonymous complexType, empty content
Defined:
locally within (this) subscriptionType complexType
XML Source (see within schema source)
<xsd:element name="trigger">
<xsd:complexType>
<xsd:attribute name="select" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
This item specifies an XPath expression that specifies the nodes that are
to be selected and watched for changes. The selection may select only
<b>xdb:blue</b>
nodes. As changes in this node set occur, they
trigger the generation of subscription messages. These messages are then sent
to the SOAP receiver listed in the
<b>to</b>
element.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="mode" use="required">
<xsd:annotation>
<xsd:documentation>
This attribute specifies whether the content of the changes
that triggered the subscription are delivered in the subscription
message, or the message simply indicates that something changed
under the trigger. The attribute may be:
<dl>
<dt>
<b>includeData</b>
</dt>
<dd>
The data that changed, causing the subscription to trigger, is
included in the subscription message. Note that deleted nodes
are specified by their ID, not by value.
</dd>
<dt>excludeData</dt>
<dd>
The data that changed, causing the subscription to trigger, is
not included in the subscription message.
</dd>
</dl>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="string">
<xsd:enumeration value="includeData"/>
<xsd:enumeration value="excludeData"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="baseChangeNumber" type="changeNumberType" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute specifies the
<b>changeNumber</b>
value to which the trigger relates. All changes between the specified change number and the current state
of the document relative to the selection are transmitted as subscription
messages. This allows a client application to establish a subscription
relative to some baseline. As with
<b>changeQuery</b>
, if the
<b>baseChangeNumber</b>
is
way out of date relative to the current state of the document, and the service
can not supply the changes in the subscription message, the subscription
insert is rejected. A value of zero means that the current values of
the selected nodes are transmitted in the subscription message.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>