Package apple.healthkit

Class 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.

    • Constructor Detail

      • HKWorkoutRouteBuilder

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object 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()

      • 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.

      • 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 java.lang.Object 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.