One Logo Pool Ball
HealthKit · IOS API REFERENCE

HKQuantitySeriesSampleQueryDescriptor.Options

struct · iOS 15.4+ · SDK 27.1

struct Options

Members (4)

get · iOS 15.4+

orderByQuantitySampleStartDate

TypeScript
get orderByQuantitySampleStartDate(): HKQuantitySeriesSampleQueryDescriptor_Options
Swift declaration
static let orderByQuantitySampleStartDate: HKQuantitySeriesSampleQueryDescriptor.Options

Determines whether the results are grouped by the containing quantity sample’s start date.

get · iOS 15.4+

includeSample

TypeScript
get includeSample(): HKQuantitySeriesSampleQueryDescriptor_Options
Swift declaration
static let includeSample: HKQuantitySeriesSampleQueryDescriptor.Options

Determines whether the `sample` property of the result should include the containing `HKQuantitySample`.

init · iOS 15.4+

init

TypeScript
init(rawValue: number): HKQuantitySeriesSampleQueryDescriptor_Options
Swift declaration
init(rawValue: Int)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 15.4+

rawValue

TypeScript
getRawValue($self: HKQuantitySeriesSampleQueryDescriptor_Options): number
Swift declaration
let rawValue: Int

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All HealthKit types →