2.2.2.12 BodyPreference

  • Article

The BodyPreference element is an optional element that sets preference information related to the type and size of information that is returned from searching, synchronizing, or fetching.

The BodyPreference element is a container data type, as specified in [MS-ASDTYPE] section 2.2.

A command response MUST NOT include the BodyPreference element. Command requests can include the BodyPreference element. The BodyPreference element, if present, has the following child elements in this order:

  • Type (section 2.2.2.41.4). This element is required.

  • TruncationSize (section 2.2.2.40.2). This element is optional.

  • AllOrNone (section 2.2.2.3.2). This element is optional.

  • Preview (section 2.2.2.35.4). This element is optional.

The contents of the airsync:Options, itemoperations:Options, or search:Options element specify preferences for all of the content that the user is interested in searching, synchronizing, or retrieving. These preferences are persisted by the server from request to request for the specified client, and can be changed by the inclusion of an airsync:Options element in any subsequent request.

A request MUST NOT contain more than one BodyPreference element for each allowable value of the Type element.

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

Yes

12.1

Yes

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes