2.2.3.181.2 SyncKey (FolderSync)
The SyncKey element is a required child element of the FolderSync element in FolderSync command requests and an optional child element of the FolderSync element in FolderSync command responses. In both contexts, it is used by the server to track the current state of the client.
All elements referenced in this section are defined in the FolderHierarchy namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
FolderSync command request (section 2.2.1.5) |
FolderSync (section 2.2.3.76) |
None |
string ([MS-ASDTYPE] section 2.7) |
1…1 (required) |
|
FolderSync command response |
FolderSync |
None |
string |
0…1 (optional) |
After successful folder synchronization, the server MUST send a synchronization key to the client. The client MUST store this key and send the key back to the server the next time the folder hierarchy is synchronized or updated. The server MUST check the value of the key to make sure the value of the SyncKey element provided in the request matches a synchronization key value on the server. The server MUST return a Status element (section 2.2.3.177.5) value of 9 if the value of the SyncKey element does not match the value of the synchronization key on the server.
The client MUST store the synchronization key as an opaque string of up to 64 characters.
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 |