apple.healthkit

Class HKWorkoutRouteBuilder

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.healthkit.HKSeriesBuilder

apple.healthkit.HKWorkoutRouteBuilder

All Implemented Interfaces:

NSObject

public class HKWorkoutRouteBuilder
extends HKSeriesBuilder

HKWorkoutRouteBuilder

An HKWorkoutRouteBuilder is used to generate an HKWorkoutRoute.

This class is intended for generating long-running location data collection such as might be associated with a workout. If the discard method is called, collected data will be deleted. Calling finishRouteWithWorkout:metadata: will stop and complete the route. If the builder is deleted, or the client goes away before calling the finish method, data will be lost.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HKWorkoutRouteBuilder.Block_addMetadataCompletion
static interface	HKWorkoutRouteBuilder.Block_finishRouteWithWorkoutMetadataCompletion
static interface	HKWorkoutRouteBuilder.Block_insertRouteDataCompletion

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HKWorkoutRouteBuilder(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
void	addMetadataCompletion(NSDictionary<java.lang.String,?> metadata, HKWorkoutRouteBuilder.Block_addMetadataCompletion completion) addMetadata:completion:
static HKWorkoutRouteBuilder	alloc()
static HKWorkoutRouteBuilder	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
void	finishRouteWithWorkoutMetadataCompletion(HKWorkout workout, NSDictionary<java.lang.String,?> metadata, HKWorkoutRouteBuilder.Block_finishRouteWithWorkoutMetadataCompletion completion) finishRouteWithWorkout:Metadata:completion:
static long	hash_static()
HKWorkoutRouteBuilder	init()
HKWorkoutRouteBuilder	initWithHealthStoreDevice(HKHealthStore healthStore, HKDevice device) initWithHealthStore:device:
void	insertRouteDataCompletion(NSArray<? extends CLLocation> routeData, HKWorkoutRouteBuilder.Block_insertRouteDataCompletion completion) insertRouteData:completion:
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
static HKWorkoutRouteBuilder	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static long	version_static()

Methods inherited from class apple.healthkit.HKSeriesBuilder

discard

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HKWorkoutRouteBuilder

protected HKWorkoutRouteBuilder(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static HKWorkoutRouteBuilder alloc()

allocWithZone

public static HKWorkoutRouteBuilder allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

finishRouteWithWorkoutMetadataCompletion

public void finishRouteWithWorkoutMetadataCompletion(HKWorkout workout,
                                                     NSDictionary<java.lang.String,?> metadata,
                                                     HKWorkoutRouteBuilder.Block_finishRouteWithWorkoutMetadataCompletion completion)

finishRouteWithWorkout:Metadata:completion:

Method to stop data collection and return the associated HKWorkoutRoute. If you are using this route builder with a workout builder, you should never call this method. The route will be finished when you finish the workout builder.

Call this method when the route has been completed. The completion handler will return the saved HKWorkoutRoute. If no series data was added, then workoutRoute will be nil and an error returned. The receiver will be considered invalid afterwards and any further calls to it will result in an error.

Parameters:

workout - The HKWorkout object to which the route will be associated. Must be saved to HealthKit

metadata - Optional metadata may be added to associate with the series. Predefined keys are found in HKMetadata.h, or private NSString keys used by the client are allowed. Acceptable metadata value types are NSString, NSDate, NSNumber and HKQuantity

completion - The completion callback handler returns the saved HKWorkoutRoute object. If workoutRoute is nil, an error will indicate why the series could not be returned including database inaccessibility during device lock. Subsequent requests for the HKWorkoutRoute can be made through HKSampleQuery or similar queries. workoutRoute cannot be associated to another workout.

hash_static

public static long hash_static()

init

public HKWorkoutRouteBuilder init()

Overrides:

init in class HKSeriesBuilder

initWithHealthStoreDevice

public HKWorkoutRouteBuilder initWithHealthStoreDevice(HKHealthStore healthStore,
                                                       HKDevice device)

initWithHealthStore:device:

The designated initializer to create an HKWorkoutRouteBuilder. If you are using an HKWorkoutBuilder , you should not create an HKWorkoutRouteBuilder, instead use -[HKWorkoutBuilder seriesBuilderForType:]

The HKHealthStore is retained during the life of the object for the saving of the series data and final return of the series sample.

Parameters:

healthStore - Specifies the HKHealthStore object to use for building the series.

device - The optional device represents the HKDevice from which the data is provided.

insertRouteDataCompletion

public void insertRouteDataCompletion(NSArray<? extends CLLocation> routeData,
                                      HKWorkoutRouteBuilder.Block_insertRouteDataCompletion completion)

insertRouteData:completion:

Associate CLLocation with the receiver.

Use this method to asynchronously add one or more CLLocation to the series. Note that CLLocation may be inserted in any order but will be sorted according to date when the series is finalized.

Parameters:

routeData - An array of one or more CLLocation.

completion - The completion callback handler returns the status of the save. If the completion handler success is NO, then error is non-nil. An error here is considered fatal and the series builder will be complete. If data was previously saved, then the HKWorkoutRoute may be retrieved by the finishRouteWithMetadata: method.

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static HKWorkoutRouteBuilder new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static

public static long version_static()

addMetadataCompletion

public void addMetadataCompletion(NSDictionary<java.lang.String,?> metadata,
                                  HKWorkoutRouteBuilder.Block_addMetadataCompletion completion)

addMetadata:completion:

Adds new metadata to the builder instance. This method can be called more than once; each time the newly provided metadata will be incorporated in the same manner as -[NSMutableDictionary addEntriesFromDictionary:]. This operation is performed asynchronously and the completion will be executed on an arbitrary background queue.

Parameters:

metadata - The metadata to add to the builder.

completion - Block to be called when the addition of metadata to the builder is complete. If success is YES, the metadata has been added to the builder successfully. If success is NO, error will be non-null and will contain the error encountered during the insertion operation. When an error occurs, the builder's metadata will remain unchanged.