HKHealthStore Class

Reference

Definition

Namespace:: HealthKit

Assembly:: Xamarin.iOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

MonoTouch.HealthKit.HKHealthStore A connection to the system-wide database of health-related information.

[Foundation.Register("HKHealthStore", 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 HKHealthStore : Foundation.NSObject

type HKHealthStore = class
    inherit NSObject

Inheritance: Object

NSObject
HKHealthStore

Attributes: RegisterAttribute IntroducedAttribute

Remarks

Individual HKHealthStore instances represent connections to the underlying data store. Instantiating a HKHealthStore does not necessarily imply that the user has granted any amount of access for reading or querying data. App devs must call RequestAuthorizationToShare(NSSet, NSSet, Action<Boolean,NSError>) or RequestAuthorizationToShareAsync(NSSet, NSSet) prior to access.

The result of RequestAuthorizationToShareAsync(NSSet, NSSet) or RequestAuthorizationToShare(NSSet, NSSet, Action<Boolean,NSError>) does not indicate that the user allowed access to the requested data; it indicates only that the user interacted with the permissions dialog (or that an error occurred while presenting that dialog). To validate access to a particular data type, developers must use the GetAuthorizationStatus(HKObjectType) method:

var temperatureKey = HKQuantityTypeIdentifierKey.BodyTemperature;
var tempQuantityType = HKObjectType.GetQuantityType (temperatureKey);

var hks = new HKHealthStore ();
var success = await hks.RequestAuthorizationToShareAsync (new NSSet (new [] { tempQuantityType }), new NSSet ());
if (success)
{
   var access = hks.GetAuthorizationStatus (tempQuantityType);
   if (access.HasFlag (HKAuthorizationStatus.SharingAuthorized)) {
	 //...etc...

Constructors

HKHealthStore()	Default constructor, initializes a new instance of this class.
HKHealthStore(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
HKHealthStore(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)
EarliestPermittedSampleDate	Gets the earliest allowable date for samples.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsHealthDataAvailable	Gets a value that indicates whether the user's health data is available.
IsProxy	(Inherited from NSObject)
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
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)
SupportsHealthRecords
UserPreferencesDidChangeNotification	Notification constant for UserPreferencesDidChange
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)
AddSamples(HKSample[], HKWorkout, HKStoreSampleAddedCallback)	Links samples to a workout.
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)
DeleteObject(HKObject, Action<Boolean,NSError>)	Deletes and object from the store and runs an action after it has been deleted.
DeleteObjectAsync(HKObject)	Deletes and object from the store and runs an action after it has been deleted.
DeleteObjects(HKObject[], Action<Boolean,NSError>)	Deletes the specified `objects` from the store and runs a completion handler when it is finished.
DeleteObjects(HKObjectType, NSPredicate, Action<Boolean,nuint,NSError>)	Deletes the objects that match the specified `objectType` and `predicate` from the store and runs a completion handler when it is finished.
DeleteObjectsAsync(HKObject[])	Deletes the specified `objects` from the store and runs a completion handler when it is finished.
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)
DisableAllBackgroundDelivery(Action<Boolean,NSError>)	Disables the background delivery of notifications and runs an action after delivery has been disabled.
DisableAllBackgroundDeliveryAsync()	Disables the background delivery of notifications and runs an action after delivery has been disabled.
DisableBackgroundDelivery(HKObjectType, Action<Boolean,NSError>)	Disables the background delivery of notifications of the specified type and runs an action after delivery has been disabled.
DisableBackgroundDeliveryAsync(HKObjectType)	Disables the background delivery of notifications of the specified type and runs an action after delivery has been disabled.
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)
EnableBackgroundDelivery(HKObjectType, HKUpdateFrequency, Action<Boolean,NSError>)	Enable the background delivery of notifications of the specified type and runs an action after delivery has been disabled.
EnableBackgroundDeliveryAsync(HKObjectType, HKUpdateFrequency)	Enable the background delivery of notifications of the specified type and runs an action after delivery has been disabled.
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExecuteQuery(HKQuery)	Runs a query.
ExposedBindings()	(Inherited from NSObject)
GetAuthorizationStatus(HKObjectType)	Returns the authorization status for `type`.
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetBiologicalSex(NSError)	Returns the user's biological sex.
GetBloodType(NSError)	Returns the user's blood type.
GetDateOfBirth(NSError)	Developers should not use this deprecated method. Developers should use 'GetDateOfBirthComponents' instead.
GetDateOfBirthComponents(NSError)	Attempts to return the date components for the user's date of birth, and reports any errors that it encounters in the `out` parameter, `error`.
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetFitzpatrickSkinType(NSError)	Attempts to return the Fitzpatrick skin type for the user, and reports any errors that it encounters in the `out` parameter, `error`.
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)
GetPreferredUnits(NSSet, Action<NSDictionary,NSError>)	Asynchronously calls `completion`, passing in a NSDictionary of HKQuantityType->HKUnit.
GetPreferredUnitsAsync(NSSet)	Asynchronously calls `completion`, passing in a NSDictionary of HKQuantityType->HKUnit.
GetRequestStatusForAuthorizationToShare(NSSet<HKSampleType>, NSSet<HKObjectType>, HKHealthStoreGetRequestStatusForAuthorizationToShareHandler)	Passes the request status, which communicates whether the app needs to request user permission, to `completion`.
GetRequestStatusForAuthorizationToShareAsync(NSSet<HKSampleType>, NSSet<HKObjectType>)	Queries the the authorization request status of the specified types.
GetWheelchairUse(NSError)	Attempts to return the wheelchair use for the user, and reports any errors that it encounters in the `out` parameter, `error`.
HandleAuthorizationForExtension(Action<Boolean,NSError>)	Requests authorization for an extension to read and write data, and runs a completion handler that receives a Boolean success value and an error object.
HandleAuthorizationForExtensionAsync()	Requests authorization for an extension to read and write data, and runs a completion handler that receives a Boolean success value and an error object.
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(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)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(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, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(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, NSString, 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)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RequestAuthorizationToShare(NSSet, NSSet, Action<Boolean,NSError>)	Requests autorization to save and read user data and runs an action after a determination has been made.
RequestAuthorizationToShareAsync(NSSet, NSSet)	Requests autorization to save and read user data and runs an action after a determination has been made.
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SaveObject(HKObject, Action<Boolean,NSError>)	Saves `obj` and runs `completion` when finished.
SaveObjectAsync(HKObject)	Saves `obj` and runs `completion` when finished.
SaveObjects(HKObject[], Action<Boolean,NSError>)	Saves the objects that are contained in `objects` and runs `completion` when finished.
SaveObjectsAsync(HKObject[])	Saves the objects that are contained in `objects` and runs `completion` when finished.
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)
SplitTotalEnergy(HKQuantity, NSDate, NSDate, Action<HKQuantity,HKQuantity,NSError>)	Splits `totalEnergy` into resting and active energy portions, and calls a handler with the result.
StartWatchApp(HKWorkoutConfiguration, Action<Boolean,NSError>)	Launches or wakes the Watch app for the workout.
StartWatchAppAsync(HKWorkoutConfiguration)	Launches or wakes the Watch app for the workout.
StopQuery(HKQuery)	Stops the specified in-progress `query`
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