2.2.3.68.2 FilterType (Sync)
The FilterType element is an optional child element of the Options element in Sync command requests that specifies an optional time window for the objects that are sent from the server to the client. It applies to email and calendar collections. If a FilterType element is specified, the server sends only objects that are dated within the specified time window.
All elements referenced in this section are defined in the AirSync namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Sync command request (section 2.2.1.21) |
Options (section 2.2.3.125.6) |
None |
unsignedByte ([MS-ASDTYPE] section 2.8) |
0...1 (optional) |
The following table lists valid values for the element.
|
Value |
Meaning |
|
Calendar |
Tasks |
|---|---|---|---|---|
|
0 |
No filter- synchronize all items |
Yes |
Yes |
Yes |
|
1 |
1 day |
Yes |
No |
No |
|
2 |
3 days |
Yes |
No |
No |
|
3 |
1 week |
Yes |
No |
No |
|
4 |
2 weeks |
Yes |
Yes |
No |
|
5 |
1 month |
Yes |
Yes |
No |
|
6 |
3 months |
No |
Yes |
No |
|
7 |
6 months |
No |
Yes |
No |
|
8 |
Filter by incomplete tasks |
No |
No |
Yes |
When the FilterType element is specified, the server manages objects on the client to maintain the time window. New objects are added when they are within the time window. The server sends SoftDelete (section 2.2.3.172) operations for objects on the client when they become older than the 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.
Calendar items that are in the future or that have recurrence but no end date are sent to the client regardless of the FilterType element value. Calendar items that fall between the FilterType element value and the present time are returned to the client. For example, an appointment that occurred two weeks ago is returned when the FilterType element value is set to 5 (one month back). The result of including a FilterType element value of 8 for a Calendar item is undefined. The server can return a protocol status error in response to such a command request.
The FilterType element is a child of the Options element. Therefore, it appears only in requests to the server from the client.
The result of including more than one FilterType element as the child of the Options element is undefined. The server MAY return a protocol status error in response to such a command request.
If the FilterType element is omitted, all objects are sent from the server without regard for their age. Clients MUST send a maximum of one FilterType element.
The server ignores the FilterType element if it is included in a contact Sync request, no error is thrown.
The server returns a Status element (section 2.2.3.177.17) value of 4 if a FilterType element value of 8 is included in an email Sync request.
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 |