3.1.4.2.3.8 m:SyncFolderItemsType Complex Type

  • Article

msdn link

The SyncFolderItemsType complex type specifies a request for synchronization information for items in the server message store. The SyncFolderItemsType complex type extends the BaseRequestType complex type ([MS-OXWSCDATA] section 2.2.4.17). 

 <xs:complexType name="SyncFolderItemsType">
   <xs:complexContent>
     <xs:extension
       base="m:BaseRequestType"
     >
       <xs:sequence>
         <xs:element name="ItemShape"
           type="t:ItemResponseShapeType"
          />
         <xs:element name="SyncFolderId"
           type="t:TargetFolderIdType"
          />
         <xs:element name="SyncState"
           type="xs:string"
           minOccurs="0"
          />
         <xs:element name="Ignore"
           type="t:ArrayOfBaseItemIdsType"
           minOccurs="0"
          />
         <xs:element name="MaxChangesReturned"
           type="t:MaxSyncChangesReturnedType"
          />
         <xs:element name="SyncScope"
           type="t:SyncFolderItemsScopeType"
           minOccurs="0"
          />
         <xs:element name="NumberOfDays"
           type="xs:int"
           minOccurs="0"
          />
         <xs:element name="MaximumCount"
           type="xs:int"
           minOccurs="0"
          />
         <xs:element name="MinimumCount"
           type="xs:int"
           minOccurs="0"
          />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 

The following table lists the child elements of the SyncFolderItemsType complex type.

Element

Type

Description

ItemShape

t:ItemResponseShapeType ([MS-OXWSCDATA] section 2.2.4.42)

Specifies the item properties that are returned in a response message.

SyncFolderId

t:TargetFolderIdType ([MS-OXWSFOLD] section 2.2.4.16)

Specifies the identity of the folder that contains the items to synchronize.

SyncState

xs:string ([XMLSCHEMA2])

Specifies the synchronization state of a previous synchronization for an incremental synchronization call. If this element is not specified, all items in their current state are returned as if the items have never been synchronized. This element is optional.

Ignore

t:ArrayOfBaseItemIdsType (section 3.1.4.2.3.1)

Specifies an array of items to skip for synchronization. This element is optional.

MaxChangesReturned

t:MaxSyncChangesReturnedType (section 3.1.4.2.4.1)

Specifies the maximum number of changes that can be returned in a synchronization response. This element MUST be set between 1 and 512, inclusive.

SyncScope

t:SyncFolderItemsScopeType (section 3.1.4.2.4.2)

Specifies whether only items or items and folder associated information (FAI) are returned. This element is optional. <7>

NumberOfDays

xs:int ([XMLSCHEMA2])

Specifies the time window (expressed in a number of days) of the items to include in a synchronization response.

MaximumCount

xs:int ([XMLSCHEMA2])

Specifies the maximum number of items (from the latest received time) to include in a synchronization response.

MinimumCount

xs:int ([XMLSCHEMA2])

Specifies the minimum number of items (from the latest received time) to include in a synchronization response.