2.2.3.27.2 Class (GetItemEstimate)
The airsync:Class element is an optional child element of the airsync:Options element in GetItemEstimate command requests. The getitemestimate:Class element is an optional child element of the Collection element in GetItemEstimate command requests. The namespace and parent element of the Class element depend on the protocol version being used. See the details about protocol versions at the end of this section.
As a child of the Collection element, the getitemestimate:Class element specifies the type of a collection. As a child of the airsync:Options element, the airsync:Class element assigns the filters within the airsync:Options container to a given class.
Elements referenced in this section are defined in the GetItemEstimate 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 |
|---|---|---|---|---|
|
GetItemEstimate command request (section 2.2.1.9) |
Collection (section 2.2.3.29.1) airsync:Options (section 2.2.3.125.2) |
None |
string ([MS-ASDTYPE] section 2.7) |
0...1 (optional) |
Options for the same class within the same collection MUST NOT be redefined. The airsync:Class element is not necessary for the default items contained within the collection (contacts in a Contacts folder for example).
For example, to sync SMS messages, include an airsync:Options node with class "SMS". To also sync email messages at the same time, include another airsync:Options node with class "Email". Only SMS messages and email messages can be synchronized at the same time; a request for any other combination of classes will fail with a status value of 4.
The valid airsync:Class element values are:
Tasks
Email
Calendar
Contacts
SMS
Notes
The valid getitemestimate:Class element values are:
Tasks
Email
Calendar
Contacts
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, child of Collection |
Element support, child of airsync:Options |
|---|---|---|
|
2.5 |
Yes |
|
|
12.0 |
Yes |
|
|
12.1 |
Yes |
|
|
14.0 |
|
Yes |
|
14.1 |
|
Yes |
|
16.0 |
|
Yes |
|
16.1 |
|
Yes |
The namespace and parent element of this element depend on the protocol version being used. For protocol versions 2.5, 12.0, and 12.1, the namespace is GetItemEstimate and the parent element is the Collection element. For protocol versions 14.0, 14.1, 16.0, and 16.1, the namespace is AirSync and the parent element is the airsync:Options element.