2.2.3.179 Supported
The Supported element is an optional child element of the Collection element, as specified in section 2.2.3.29.2, in Sync command requests (section 2.2.1.21) that specifies which contact and calendar elements in a Sync request are managed by the client and therefore not ghosted. Elements that are not named by the Supported element are said to be ghosted.
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 |
Collection (section 2.2.3.29.2) |
See the description following this table. |
container ([MS-ASDTYPE] section 2.2) |
0...1 (optional) |
The status of properties that can be ghosted is determined by the client's usage of the Supported element in the initial Sync command request for the containing folder, according to the following rules:
If the client does not include a Supported element in the initial Sync command request for a folder, then all of the elements that can be ghosted are considered not ghosted.
If the client includes a Supported element that contains child elements in the initial Sync command request for a folder, then each child element of that Supported element is considered not ghosted. All elements that can be ghosted that are not included as child elements of the Supported element are considered ghosted.
If the client includes an empty Supported element in the initial Sync command request for a folder, then all elements that can be ghosted are considered ghosted.
When an existing item is modified via the Change element (section 2.2.3.24) in a Sync command request, the result of omitting an element that can be ghosted changes depending on the status of the element. If the element is ghosted, any existing value for that element is preserved. If the element is not ghosted, any existing value for that element is deleted.
The initial Sync request for a folder MUST include a CollectionId element (section 2.2.3.30.6), which MUST precede the optional Supported element. For details about the order of elements within the Collection node, see section 2.2.3.29.2. This order is strictly enforced. A Status element (section 2.2.3.177.17) value of 4 is returned in the Sync response if the CollectionId element is not included in the Sync request. A Status element value of 4 is also returned if the order of elements is incorrect within the Collection node.
If the client uses the Supported element, it MUST be sent in a Sync command request when the SyncKey element value (section 2.2.3.181.4) is set to 0 (zero). The server caches the list of child elements of the Supported element for subsequent synchronizations. If the Supported element is included when the SyncKey element value is not set to 0 (zero), no error is returned, but the server ignores the request.
All of the Contact class properties specified in [MS-ASCNTC] can be included as child elements of the Supported element.
To support elements of the Calendar class, as specified in [MS-ASCAL], the following required elements MUST be included as child elements of the Supported element when protocol version 2.5, 12.0, 12.1, 14.0, or 14.1 is used:
§ calendar:DtStamp ([MS-ASCAL] section 2.2.2.18)
§ calendar:Categories ([MS-ASCAL] section 2.2.2.11)
§ calendar:Sensitivity ([MS-ASCAL] section 2.2.2.41)
§ calendar:BusyStatus ([MS-ASCAL] section 2.2.2.9)
§ calendar:UID ([MS-ASCAL] section 2.2.2.46)
§ calendar:Timezone ([MS-ASCAL] section 2.2.2.44)
§ calendar:StartTime ([MS-ASCAL] section 2.2.2.42)
§ calendar:Subject ([MS-ASCAL] section 2.2.2.43)
§ calendar:Location ([MS-ASCAL] section 2.2.2.27)
§ calendar:EndTime ([MS-ASCAL] section 2.2.2.20)
§ calendar:Recurrence ([MS-ASCAL] section 2.2.2.37)
§ calendar:AllDayEvent ([MS-ASCAL] section 2.2.2.1)
§ calendar:Reminder ([MS-ASCAL] section 2.2.2.38)
§ calendar:Exceptions ([MS-ASCAL] section 2.2.2.22)
The following elements are optional child elements of the Supported element when synchronizing the Calendar class.
§ calendar:Attendees ([MS-ASCAL] section 2.2.2.4)
§ calendar:OrganizerName ([MS-ASCAL] section 2.2.2.36)
§ calendar:OrganizerEmail ([MS-ASCAL] section 2.2.2.35)
§ calendar:MeetingStatus ([MS-ASCAL] section 2.2.2.28)
§ calendar:ResponseRequested ([MS-ASCAL] section 2.2.2.39)
§ calendar:DisallowNewTimeProposal ([MS-ASCAL] section 2.2.2.17)
For more information on which properties are ghosted by default, consult the ActiveSync class protocol specifications, [MS-ASCAL] and [MS-ASCNTC].
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 |
When synchronizing the Calendar class: The ResponseRequested element and the DisallowNewTimeProposal element are not supported as a child elements of the Supported element when the protocol version 2.5, 12.0, or 12.1 is used.
All Calendar class properties are ghosted by default when protocol version 16.0 or 16.1 is used.