Edit

Share via


HKQuery Class

Definition

Base class for querying Health Kit databases.

[Foundation.Register("HKQuery", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 2, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class HKQuery : Foundation.NSObject
type HKQuery = class
    inherit NSObject
Inheritance
HKQuery
Derived
Attributes

Constructors

HKQuery(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

HKQuery(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
ObjectType

Gets the type of object that will be queried.

Predicate

Gets a predicate that filters objects that are returned from the HealthKit store.

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
SampleType

Developers should not use this deprecated property. Developers should use 'ObjectType' property.

Self (Inherited from NSObject)
Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)
Obsolete.
(Inherited from NSObject)
BindingInfo(String)
Obsolete.
(Inherited from NSObject)
BindingOptionDescriptions(String)
Obsolete.
(Inherited from NSObject)
BindingValueClass(String)
Obsolete.
(Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String)
Obsolete.
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetPredicateForActivitySummariesBetween(NSDateComponents, NSDateComponents)

Returns a predicate that matches activity summaries for activities that occurred between the provided dates.

GetPredicateForActivitySummary(NSDateComponents)

Returns a predicate that matches the activity summary for activities that occurred on the specifie day.

GetPredicateForCategorySamples(NSPredicateOperatorType, nint)

Creates and returns a predicate that can be used to check the value of a category sample.

GetPredicateForClinicalRecords(HKFhirResourceType)

Creates and returns a predicate for a Fast Healthcare Interoperability Resources record of the specified resource type.

GetPredicateForClinicalRecords(HKSource, HKFhirResourceType, String)

Creates and returns a predicate for a Fast Healthcare Interoperability Resources record for the specified query parameters.

GetPredicateForDuration(NSPredicateOperatorType, Double)

Creates and returns a predicate that can be used to get workouts by duration.

GetPredicateForMetadataKey(NSString, NSObject[])

Creates and returns a predicate that can be used to get objects by metadata key and value.

GetPredicateForMetadataKey(NSString, NSPredicateOperatorType, NSObject)

Creates and returns a predicate that can be used to get objects by metadata key and value.

GetPredicateForMetadataKey(NSString)

Creates and returns a predicate that can be used to get objects by metadata key.

GetPredicateForObject(NSUuid)

Creates and returns a predicate that can be used to get objects by UUID.

GetPredicateForObjects(NSSet)

Creates and returns a predicate that can be used to get multiple objects by UUID.

GetPredicateForObjectsFromDevices(NSSet<HKDevice>)

Returns a predicate that matches objects for activities from the specified devices.

GetPredicateForObjectsFromSource(HKSource)

Creates and returns a predicate that can be used to get objects from a specified source.

GetPredicateForObjectsFromSourceRevisions(NSSet<HKSourceRevision>)

Returns a predicate that matches objects from the specified source revisions.

GetPredicateForObjectsFromSources(NSSet)

Creates and returns a predicate that can be used to get objects from a set of sources.

GetPredicateForObjectsFromWorkout(HKWorkout)

Creates and returns a predicate that can be used to get objects from a workout.

GetPredicateForObjectsWithDeviceProperty(String, NSSet<NSString>)

Returns a predicate that matches objects that have any of the allowed values for the property that is identified by the specified key.

GetPredicateForQuantitySamples(NSPredicateOperatorType, HKQuantity)

Creates and returns a predicate that can be used to get samples by quantity.

GetPredicateForSamples(NSDate, NSDate, HKQueryOptions)

Creates and returns a predicate that can be used to get samples that are in a date range.

GetPredicateForTotalDistance(NSPredicateOperatorType, HKQuantity)

Creates and returns a predicate that can be used to get workouts by distance.

GetPredicateForTotalEnergyBurned(NSPredicateOperatorType, HKQuantity)

Creates and returns a predicate that can be used to get workouts by energy consumed.

GetPredicateForTotalFlightsClimbed(NSPredicateOperatorType, HKQuantity)
GetPredicateForTotalSwimmingStrokeCount(NSPredicateOperatorType, HKQuantity)

Returns a predicate that matches workousts that have the specified totalSwimmingStrokeCount.

GetPredicateForWorkouts(HKWorkoutActivityType)

Creates and returns a predicate that can be used to get workouts by activity type.

Init() (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PredicateForObjectsWithNoCorrelation()

Creates and returns a predicate for objects that do not have a HealthKit correlation.

PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject)
Obsolete.
(Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
Obsolete.
(Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also