2.2.3.30.6 CollectionId (Sync)
The CollectionId element is a required child element of the Collection element in Sync command requests and responses that specifies the server ID of the folder to be synchronized.
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) |
None |
string ([MS-ASDTYPE] section 2.7) |
1…1 (required) |
|
Sync command response |
Collection (section 2.2.3.29.2) |
None |
string |
1…1 (required) |
The server ID of the folder is obtained from the folderhierarchy:ServerId element (section 2.2.3.166) of a previous FolderSync command response (section 2.2.1.5) or FolderCreate command response (section 2.2.1.3). The CollectionId element value can be up to 64 characters in length.
The CollectionId value "RI" specifies the recipient information cache, which contains a list of contacts that the user has interacted with most often in the near term, and with whom the user is likely to interact again. The recipient information cache is a special folder (similar to the Inbox folder), which limits the operations that can be performed on it.
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 |