HKWorkoutBuilder Class
Definition
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.
Builds a workout from workout data as it is added.
[Foundation.Register("HKWorkoutBuilder", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 5, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 12, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class HKWorkoutBuilder : Foundation.NSObjecttype HKWorkoutBuilder = class
inherit NSObject- Inheritance
- Attributes
Constructors
| HKWorkoutBuilder(HKHealthStore, HKWorkoutConfiguration, HKDevice) |
Creates a new workout builder. |
| HKWorkoutBuilder(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| HKWorkoutBuilder(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) |
| Device |
Gets the device that is providing the workout data. |
| EndDate |
Gets the end time of the workout. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| Metadata |
Gets the workout metadata. |
| NativeMetadata |
Gets the metadata as a NSDictionary. |
| RetainCount |
Returns the current Objective-C retain count for the object. (Inherited from NSObject) |
| Self | (Inherited from NSObject) |
| StartDate |
Gets the start time of the workout. |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| WorkoutConfiguration |
Gets the workout configuration. |
| WorkoutEvents |
Gets an array that contains the workout events. |
| Zone | (Inherited from NSObject) |
Methods
| Add(HKMetadata, HKWorkoutBuilderCompletionHandler) |
Adds the specified metadata to the workout and runs a handler when the operation completes. |
| Add(HKSample[], HKWorkoutBuilderCompletionHandler) |
Adds the specified samples to the workout and runs a handler when the operation completes. |
| Add(HKWorkoutEvent[], HKWorkoutBuilderCompletionHandler) |
Adds the specified workout events to the workout and runs a handler when the operation completes. |
| Add(NSDictionary, HKWorkoutBuilderCompletionHandler) |
Adds the specified metadata to the workout and runs a handler when the operation completes. |
| AddAsync(HKMetadata) |
Adds the specified metadata and returns a task that contains a success status and any error that occurred. |
| AddAsync(HKSample[]) |
Adds the specified samples and returns a task that contains a success status and any error that occurred. |
| AddAsync(HKWorkoutEvent[]) |
Adds the specified workout events and returns a task that contains a success status and any error that occurred. |
| AddAsync(NSDictionary) |
Adds the specified metadata and returns a task that contains a success status and any error that occurred. |
| 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) |
| BeginCollection(NSDate, HKWorkoutBuilderCompletionHandler) |
Starts the workout at the sepcified time. Begins collecting workout data. |
| BeginCollectionAsync(NSDate) |
Starts the workout at the sepcified time, begins collecting workout data, and returns a task that contains a success status and any error that occurred. |
| 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) |
| DiscardWorkout() |
Discards the workout. |
| 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) |
| EndCollection(NSDate, HKWorkoutBuilderCompletionHandler) |
Ends the workout and runs a handler when the operation completes. |
| EndCollectionAsync(NSDate) |
Ends the workout and returns a task that contains a success status and any error that occured. |
| Equals(NSObject) | (Inherited from NSObject) |
| Equals(Object) | (Inherited from NSObject) |
| ExposedBindings() | (Inherited from NSObject) |
| FinishWorkout(HKWorkoutBuilderCompletionHandler) |
Saves a new workout, created with the collected data, to the Health Store. |
| FinishWorkoutAsync() |
Saves a new workout, created with the collected data, to the Health Store. Returns a handler that contains a success status and any error that occurred. |
| 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) |
| GetElapsedTime(NSDate) |
Returns the time between the start of the workout and |
| 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) |
| GetSeriesBuilder(HKSeriesType) |
Returns a builder for the series type. |
| GetStatistics(HKQuantityType) |
Returns a statistics object for data of the specified quantity type. |
| 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 |
| 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) |
| 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 |
| SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) |
Sets the array of UIAccessibilityCustomRotor objects appropriate for |