2.2.3.125.6 Options (Sync)
The Options element is an optional child element of the Collection element in Sync command requests that contains elements that control certain aspects of how the synchronization is performed.
Elements referenced in this section are defined in the AirSync namespace, except where otherwise indicated by the presence of a namespace prefix (as defined in section 2.2.4).
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Sync command request (section 2.2.1.21) |
Collection (section 2.2.3.29.2) |
FilterType (section 2.2.3.68.2) Conflict (section 2.2.3.34) MIMETruncation (section 2.2.3.111) MIMESupport (section 2.2.3.110.3) Class (section 2.2.3.27.6) MaxItems (section 2.2.3.103.2) Truncation (section 2.2.3.185) airsyncbase:BodyPreference ([MS-ASAIRS] section 2.2.2.12) airsyncbase:BodyPartPreference ([MS-ASAIRS] section 2.2.2.11) |
container ([MS-ASDTYPE] section 2.2) |
0...2 (optional) |
This element is optional, but if it is present, it SHOULD include at least one child element. The Options element appears only in requests to the server from the client.
Synchronization options enable the client to specify truncation and content settings. These settings are encapsulated within a airsyncbase:BodyPreference child element, as specified in [MS-ASAIRS] section 2.2.2.12.
Because synchronization options are specified on a collection, the client can specify a unique airsyncbase:BodyPreference element value for each collection that it is being synchronized. For more details about the airsyncbase:BodyPreference element, see [MS-ASAIRS] section 2.2.2.12.
The server preserves the Options block across requests, using a concept referred to as "sticky options". If the Options block is not included in a request, the previous Options block is used. Whenever the client specifies new options by including an Options block in the request, the server MUST replace the original Options block with the new Options block.
If two Options elements are included in a single Sync command request, one of the Options elements MUST specify the synchronization options for the SMS class, while the other Options element specifies the options for the default class of the given folder.
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
|
Protocol version |
Element support |
|---|---|
|
2.5 |
Yes |
|
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |
All protocol versions except 2.5 support the airsyncbase:BodyPreference element as a child element of the Options element in a Sync command request. The airsyncbase:BodyPartPreference element and the rm:RightsManagementSupport element are supported as a child elements of the Options element only when protocol version 14.1, 16.0, or 16.1 is used. Protocol version support of other elements referenced in this section is specified in the individual sections that define those elements.