element <trigger> (local)
Namespace:
http://schemas.microsoft.com/hs/2001/10/core
Type:
anonymous complexType
Content:
empty, 3 attributes
Defined:
locally within subscriptionType complexType in hscommon.xsd; see XML source
Includes:
definitions of 3 attributes
XML Representation Summary
<trigger
   
 = 
xsd:nonNegativeInteger
 = 
("includeData" | "excludeData")
 = 
xsd:string
/>
Included in content model of 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)
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>
Attribute Detail (all declarations; 3/3)
baseChangeNumber
Type:
changeNumberType
Use:
optional
Defined:
locally within (this) trigger element
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.
XML Source (see within schema source)
<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>
mode
Type:
anonymous simpleType (restriction of string)
Use:
required
Defined:
locally within (this) trigger element
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>
Anonymous simpleType
Derivation:
restriction of string
XML Source (see within schema source)
<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>
select
Type:
xsd:string, predefined
Use:
required
Defined:
locally within (this) trigger element
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.
XML Source (see within schema source)
<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>