Share via

2.2.3.29.2 Collection (Sync)

  • Article

The Collection element is a required child element of the Collections element in Sync command requests, and an optional child element in Sync command responses. In both contexts, it contains commands and options that apply to a particular collection.

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)

Collections (section 2.2.3.31.2)

Class (section 2.2.3.27.6)

SyncKey (section 2.2.3.181.4)

Supported (section 2.2.3.179)

CollectionId (section 2.2.3.30.6)

DeletesAsMoves (section 2.2.3.43)

GetChanges (section 2.2.3.84)

WindowSize (section 2.2.3.199)

Options (section 2.2.3.125.6)

ConversationMode (section 2.2.3.36.2)

Commands (section 2.2.3.32)

container ([MS-ASDTYPE] section 2.2)

1...N (required)

Sync command response

Collections

Class

SyncKey

CollectionId

Status (section 2.2.3.177.17)

MoreAvailable (section 2.2.3.116)

Commands

Responses (section 2.2.3.154)

container

0…N (optional)

The Collection element contains identification information (CollectionId), synchronization state (SyncKey), commands (GetChanges, Commands), and options (WindowSize, Options, DeletesAsMoves, MoreAvailable).

There is a strict ordering of the XML elements within a Collection node in a Sync command request. The order is as follows:

1. SyncKey

2. CollectionId

3. Supported

4. DeletesAsMoves

5. GetChanges

6. WindowSize

7. ConversationMode

8. Options

9. Commands

A single Collections element can contain multiple Collection elements. Therefore, each Collection does not require its own Sync command. That is, a Sync command request can specify multiple collections to be synchronized.

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

Only one collection can be specified when protocol version 2.5 or 12.0 is used.

The Class element is a supported child element of the Collection element only when protocol version 2.5, 12.0, or 12.1 is used.