One Logo Pool Ball
HealthKit · IOS API REFERENCE

HKDocumentQuery

class · iOS 10.0+ · SDK 27.1

class HKDocumentQuery

Members (4)

init · iOS 10.0+

init

TypeScript
static init(documentType: HKDocumentType, predicate: (_Foundation_NSPredicate) | null, limit: number, sortDescriptors: (Array<_Foundation_NSSortDescriptor>) | null, includeDocumentData: boolean, resultsHandler: ((arg0: HKDocumentQuery, arg1: (Array<HKDocumentSample>) | null, arg2: boolean, arg3: (NativeError) | null) => void)): HKDocumentQuery
Swift declaration
init(documentType: HKDocumentType, predicate: NSPredicate?, limit: Int, sortDescriptors: [NSSortDescriptor]?, includeDocumentData: Bool, resultsHandler: @escaping @Sendable (HKDocumentQuery, [HKDocumentSample]?, Bool, (any Error)?) -> Void)
get · iOS 10.0+

includeDocumentData

TypeScript
get includeDocumentData(): boolean
Swift declaration
var includeDocumentData: Bool { get }
get · iOS 10.0+

limit

TypeScript
get limit(): number
Swift declaration
var limit: Int { get }
get · iOS 10.0+

sortDescriptors

TypeScript
get sortDescriptors(): (Array<_Foundation_NSSortDescriptor>) | null
Swift declaration
var sortDescriptors: [NSSortDescriptor]? { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

HKDocumentQuery.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All HealthKit types →