2.2.3.68.1 FilterType (GetItemEstimate)
The airsync:FilterType element is an optional child element of the airsync:Options element and a required child element of the Collection element in GetItemEstimate command requests. In both contexts, it specifies a time window for the objects sent from the server to the client. The parent element of the airsync:FilterType element depends on the protocol version being used. See the details about protocol versions at the end of this section.
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 |
integer ([MS-ASDTYPE] section 2.6) |
1...1 (required) for Collection 0...1 (optional) for airsync:Options |
The airsync:FilterType element applies to email, calendar, and task collections. If a filter type is specified, then the server sends an estimate of the items within the filter specifications.
If the airsync:FilterType element is present in the request, then the server manages objects on the client to maintain the specified time window. New objects are added to the client when they are within the time window. The start time of the time window is determined by subtracting the period of time represented by the value of the FilterType element from the current time. Any items that are dated between the start time of the window and the current time are considered within the time window. For example, if the value of the FilterType element is 2, then the start time of the time window is three days prior to the current time. If the airsync:FilterType element is omitted, then all objects are sent from the server.
Calendar items that are in the future or that have recurrence, but no end date, are sent to the client regardless of the airsync:FilterType element value.
The airsync:FilterType element does not support contact collections. However, if the airsync:FilterType element is included in a GetItemEstimate request for a contact collection, no error is returned.
The valid values for each collections type are listed in the following table.
|
Value |
Meaning |
Applies to email |
Applies to calendar |
Applies to tasks |
|---|---|---|---|---|
|
0 |
No filter |
Yes |
Yes |
Yes |
|
1 |
1 day |
Yes |
No, Status element (section 2.2.3.177.7) value 110 |
No, Status element value 110 |
|
2 |
3 days |
Yes |
No, Status element value 110 |
No, Status element value 110 |
|
3 |
1 week |
Yes |
No, Status element value 110 |
No, Status element value 110 |
|
4 |
2 weeks |
Yes |
Yes |
No, Status element value 110 |
|
5 |
1 month |
Yes |
Yes |
No, Status element value 110 |
|
6 |
3 months |
No, Status element value 110 |
Yes |
No, Status element value 110 |
|
7 |
6 months |
No, Status element value 110 |
Yes |
No, Status element value 110 |
|
8 |
Incomplete tasks |
No, Status element value 110 |
No, Status element value 110 |
Yes |
Specifying a airsync:FilterType of 9 or above for when the CollectionId element (section 2.2.3.30.2) identifies any email, contact, calendar or task collection results in a Status element value of 103.
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 FilterType element is a required child element of the Collection element when protocol version 2.5, 12.0, or 12.1 is used; the FilterType element is an optional child element of the airsync:Options element when protocol version 14.0, 14.1, 16.0, or 16.1 is used.