3.1.4.3.3.3 t:BaseSubscriptionRequestType Complex Type

  • Article

The BaseSubscriptionRequestType complex type specifies the base class for descendant classes that form the notification requests.

 <xs:complexType name="BaseSubscriptionRequestType"
   abstract="true"
 > 
   <xs:sequence>
     <xs:element name="FolderIds"
       type="t:NonEmptyArrayOfBaseFolderIdsType"
       minOccurs="0"
      />
     <xs:element name="EventTypes"
       type="t:NonEmptyArrayOfNotificationEventTypesType"
      />
     <xs:element name="Watermark"
       type="t:WatermarkType"
       minOccurs="0"
      />
   </xs:sequence>
   <xs:attribute name="SubscribeToAllFolders" type="xs:boolean" use="optional"/>
 </xs:complexType>
 

The following table lists and describes the child elements of the BaseSubscriptionRequestType complex type.

Element name

Type

Description

FolderIds

t:NonEmptyArrayOfBaseFolderIdsType ([MS-OXWSFOLD] section 3.1.4.6.3.3)

Specifies an array of folder identifiers that are used to identify folders to be monitored for event notifications.

EventTypes

t:NonEmptyArrayOfNotificationEventTypesType (section 3.1.4.3.3.4)

Specifies the monitored event types for a notification subscription.

Watermark

t:WatermarkType (section 2.2.5.1)

Specifies an event bookmark in the mailbox event queue.

The following table lists and describes the attributes of the BaseSubscriptionRequestType complex type.

Attribute Name

Type

Description

SubscribeToAllFolders

1. xs:boolean [XMLSCHEMA2]

If true, identifies that this subscription apply to all folders and FolderIds MUST be null or empty.<10>