2.2.3.181.1 SyncKey (FolderCreate, FolderDelete, and FolderUpdate)
The SyncKey element is a used in FolderCreate command requests and responses, FolderDelete command and responses, and FolderUpdate command and responses to represent the synchronization state of a collection.
All elements referenced in this section are defined in the FolderHierarchy namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
FolderCreate command request (section 2.2.1.3) |
FolderCreate (section 2.2.3.72) |
None |
string ([MS-ASDTYPE] section 2.7) |
1…1 (required) |
|
FolderCreate command response |
FolderCreate |
None |
string |
0...1 (optional) |
|
FolderDelete command request (section 2.2.1.4) |
FolderDelete (section 2.2.3.73) |
None |
string |
1…1 (required) |
|
FolderDelete command response |
FolderDelete |
None |
string |
0...1 (optional) |
|
FolderUpdate command request (section 2.2.1.6) |
FolderUpdate (section 2.2.3.77) |
None |
string |
1…1 (required) |
|
FolderUpdate command response |
FolderUpdate |
None |
string |
0…1 (optional) |
The server returns a Status element (section 2.2.3.177.6) value of 10 if the SyncKey element is not included in a FolderUpdate command request.
After a successful FolderCreate command (section 2.2.1.3), FolderDelete command (section 2.2.1.4), or FolderUpdate command (section 2.2.1.6), the server MUST send a synchronization key to the client in a response. If the FolderCreate command, FolderDelete command, or FolderUpdate command is not successful, the server MUST NOT return a SyncKey element.
The client MUST store this key and send it 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, FolderCreate |
Element support, FolderDelete |
Element support, FolderUpdate |
|---|---|---|---|
|
2.5 |
Yes |
Yes |
Yes |
|
12.0 |
Yes |
Yes |
Yes |
|
12.1 |
Yes |
Yes |
Yes |
|
14.0 |
Yes |
Yes |
Yes |
|
14.1 |
Yes |
Yes |
Yes |
|
16.0 |
Yes |
Yes |
Yes |
|
16.1 |
Yes |
Yes |
Yes |