2.2.3.88.2 HeartbeatInterval (Sync)
The HeartbeatInterval element is an optional child element of the Sync element in Sync command requests that specifies the number of seconds that the server SHOULD delay a response if no new items are added to the included folders, as specified in section 3.1.5.4.
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) |
Sync (section 2.2.3.180) |
None |
integer ([MS-ASDTYPE] section 2.6) |
0...1 (optional) |
Valid values for the HeartbeatInterval element are implementation-specific.<7> When the client requests an interval that is outside the acceptable range, the server will send a response that includes a Status element (section 2.2.3.177.17) value of 14 and a Limit element.<8>
Either the HeartbeatInterval element or the Wait element (section 2.2.3.198) can be included in a Sync command request, but not both. If both elements are included, the server response will contain a Status element value of 4.
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 |
|
|
12.0 |
|
|
12.1 |
|
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |