Class HKDocumentQuery

  • All Implemented Interfaces:
    NSObject

    public class HKDocumentQuery
    extends HKQuery
    HKDocumentQuery A concrete subclass of HKQuery that provides an interface to retrieve documents from the Health store. API-Since: 10.0
    • Constructor Detail

      • HKDocumentQuery

        protected HKDocumentQuery​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • allocWithZone

        public static HKDocumentQuery allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                                   @NotNull java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                                   @NotNull java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                                 @NotNull java.lang.Object aTarget,
                                                                                 @NotNull
                                                                                 @NotNull org.moe.natj.objc.SEL aSelector,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        @NotNull
        public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        @NotNull
        public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()
      • debugDescription_static

        public static java.lang.String debugDescription_static()
      • description_static

        public static java.lang.String description_static()
      • hash_static

        public static long hash_static()
      • 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

        @NotNull
        public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                             @NotNull java.lang.String key)
      • predicateForActivitySummariesBetweenStartDateComponentsEndDateComponents

        @NotNull
        public static @NotNull NSPredicate predicateForActivitySummariesBetweenStartDateComponentsEndDateComponents​(@NotNull
                                                                                                                    @NotNull NSDateComponents startDateComponents,
                                                                                                                    @NotNull
                                                                                                                    @NotNull NSDateComponents endDateComponents)
      • predicateForActivitySummaryWithDateComponents

        @NotNull
        public static @NotNull NSPredicate predicateForActivitySummaryWithDateComponents​(@NotNull
                                                                                         @NotNull NSDateComponents dateComponents)
      • predicateForCategorySamplesWithOperatorTypeValue

        @NotNull
        public static @NotNull NSPredicate predicateForCategorySamplesWithOperatorTypeValue​(long operatorType,
                                                                                            long value)
      • predicateForObjectWithUUID

        @NotNull
        public static @NotNull NSPredicate predicateForObjectWithUUID​(@NotNull
                                                                      @NotNull NSUUID UUID)
      • predicateForObjectsFromDevices

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsFromDevices​(@NotNull
                                                                          @NotNull NSSet<? extends HKDevice> devices)
      • predicateForObjectsFromSource

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsFromSource​(@NotNull
                                                                         @NotNull HKSource source)
      • predicateForObjectsFromSourceRevisions

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsFromSourceRevisions​(@NotNull
                                                                                  @NotNull NSSet<? extends HKSourceRevision> sourceRevisions)
      • predicateForObjectsFromSources

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsFromSources​(@NotNull
                                                                          @NotNull NSSet<? extends HKSource> sources)
      • predicateForObjectsFromWorkout

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsFromWorkout​(@NotNull
                                                                          @NotNull HKWorkout workout)
      • predicateForObjectsWithDevicePropertyAllowedValues

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithDevicePropertyAllowedValues​(@NotNull
                                                                                              @NotNull java.lang.String key,
                                                                                              @NotNull
                                                                                              @NotNull NSSet<java.lang.String> allowedValues)
      • predicateForObjectsWithMetadataKey

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithMetadataKey​(@NotNull
                                                                              @NotNull java.lang.String key)
      • predicateForObjectsWithMetadataKeyAllowedValues

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithMetadataKeyAllowedValues​(@NotNull
                                                                                           @NotNull java.lang.String key,
                                                                                           @NotNull
                                                                                           @NotNull NSArray<?> allowedValues)
      • predicateForObjectsWithMetadataKeyOperatorTypeValue

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithMetadataKeyOperatorTypeValue​(@NotNull
                                                                                               @NotNull java.lang.String key,
                                                                                               long operatorType,
                                                                                               @NotNull
                                                                                               @NotNull java.lang.Object value)
      • predicateForObjectsWithNoCorrelation

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithNoCorrelation()
      • predicateForObjectsWithUUIDs

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsWithUUIDs​(@NotNull
                                                                        @NotNull NSSet<? extends NSUUID> UUIDs)
      • predicateForQuantitySamplesWithOperatorTypeQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForQuantitySamplesWithOperatorTypeQuantity​(long operatorType,
                                                                                               @NotNull
                                                                                               @NotNull HKQuantity quantity)
      • predicateForSamplesWithStartDateEndDateOptions

        @NotNull
        public static @NotNull NSPredicate predicateForSamplesWithStartDateEndDateOptions​(@Nullable
                                                                                          @Nullable NSDate startDate,
                                                                                          @Nullable
                                                                                          @Nullable NSDate endDate,
                                                                                          long options)
      • predicateForWorkoutsWithOperatorTypeDuration

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeDuration​(long operatorType,
                                                                                        double duration)
      • predicateForWorkoutsWithOperatorTypeTotalDistance

        @NotNull
        @Deprecated
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeTotalDistance​(long operatorType,
                                                                                             @NotNull
                                                                                             @NotNull HKQuantity totalDistance)
        Deprecated.
      • predicateForWorkoutsWithOperatorTypeTotalEnergyBurned

        @NotNull
        @Deprecated
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeTotalEnergyBurned​(long operatorType,
                                                                                                 @NotNull
                                                                                                 @NotNull HKQuantity totalEnergyBurned)
        Deprecated.
      • predicateForWorkoutsWithOperatorTypeTotalSwimmingStrokeCount

        @NotNull
        @Deprecated
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeTotalSwimmingStrokeCount​(long operatorType,
                                                                                                        @NotNull
                                                                                                        @NotNull HKQuantity totalSwimmingStrokeCount)
        Deprecated.
      • predicateForWorkoutsWithWorkoutActivityType

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithWorkoutActivityType​(long workoutActivityType)
      • 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()
      • includeDocumentData

        public boolean includeDocumentData()
        [@property] includeDocumentData The XML content for documents may be large. This property can be used to control whether the query returns the XML content for each record.
      • initWithDocumentTypePredicateLimitSortDescriptorsIncludeDocumentDataResultsHandler

        public HKDocumentQuery initWithDocumentTypePredicateLimitSortDescriptorsIncludeDocumentDataResultsHandler​(@NotNull
                                                                                                                  @NotNull HKDocumentType documentType,
                                                                                                                  @Nullable
                                                                                                                  @Nullable NSPredicate predicate,
                                                                                                                  long limit,
                                                                                                                  @Nullable
                                                                                                                  @Nullable NSArray<? extends NSSortDescriptor> sortDescriptors,
                                                                                                                  boolean includeDocumentData,
                                                                                                                  @NotNull
                                                                                                                  @NotNull HKDocumentQuery.Block_initWithDocumentTypePredicateLimitSortDescriptorsIncludeDocumentDataResultsHandler resultsHandler)
        initWithDocumentType:predicate:limit:sortDescriptors:includeDocumentData:resultsHandler: Returns a query that will retrieve HKDocumentSamples matching the given predicate. Health documents may contain sensitive data that a user may want to control explicitly. HKDocumentSample objects returned by HKSampleQuery and HKAnchoredObjectQuery do not include this data (i.e., the document property is nil). This query can be used to retrieve fully populated HKDocumentSample instances. The query will prompt the user to authorize your app to read individual documents. The query will then return the documents that your app is authorized to read. The user will only be asked to authorize your app to read documents that are new since the last time an HKDocumentQuery was executed.
        Parameters:
        documentType - The type of document to retreive.
        predicate - The predicate which documents should match.
        limit - The maximum number of documents to return. Pass HKObjectQueryNoLimit for no limit.
        sortDescriptors - The sort descriptors to use to order the resulting documents.
        includeDocumentData - If true, the document content will be returned with the HKDocumentSample instance. This option can be used to limit the size of the content returned since the content may be large.
        resultsHandler - The block that will receive query results. Results will be returned incrementally through several calls to this block. When there are no more results, the done parameter will be YES and the results array will be empty. If results is nil, then an error has occurred and the error parameter will be set. Delivery of results can be stopped by calling HKHealthStore's stopQuery: method.
      • limit

        public long limit()
        [@property] limit The maximum number of documents the receiver will return upon completion.
      • sortDescriptors

        @Nullable
        public @Nullable NSArray<? extends NSSortDescriptor> sortDescriptors()
        [@property] sortDescriptors An array of NSSortDescriptors.
      • predicateForWorkoutsWithOperatorTypeTotalFlightsClimbed

        @NotNull
        @Deprecated
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeTotalFlightsClimbed​(long operatorType,
                                                                                                   @NotNull
                                                                                                   @NotNull HKQuantity totalFlightsClimbed)
        Deprecated.
      • predicateForClinicalRecordsFromSourceFHIRResourceTypeIdentifier

        @NotNull
        public static @NotNull NSPredicate predicateForClinicalRecordsFromSourceFHIRResourceTypeIdentifier​(@NotNull
                                                                                                           @NotNull HKSource source,
                                                                                                           @NotNull
                                                                                                           @NotNull java.lang.String resourceType,
                                                                                                           @NotNull
                                                                                                           @NotNull java.lang.String identifier)
      • predicateForClinicalRecordsWithFHIRResourceType

        @NotNull
        public static @NotNull NSPredicate predicateForClinicalRecordsWithFHIRResourceType​(@NotNull
                                                                                           @NotNull java.lang.String resourceType)
      • predicateForElectrocardiogramsWithClassification

        @NotNull
        public static @NotNull NSPredicate predicateForElectrocardiogramsWithClassification​(long classification)
      • predicateForElectrocardiogramsWithSymptomsStatus

        @NotNull
        public static @NotNull NSPredicate predicateForElectrocardiogramsWithSymptomsStatus​(long symptomsStatus)
      • predicateForObjectsAssociatedWithElectrocardiogram

        @NotNull
        public static @NotNull NSPredicate predicateForObjectsAssociatedWithElectrocardiogram​(@NotNull
                                                                                              @NotNull HKElectrocardiogram electrocardiogram)
      • predicateForVerifiableClinicalRecordsWithRelevantDateWithinDateInterval

        @NotNull
        public static @NotNull NSPredicate predicateForVerifiableClinicalRecordsWithRelevantDateWithinDateInterval​(@NotNull
                                                                                                                   @NotNull NSDateInterval dateInterval)
      • predicateForCategorySamplesEqualToValues

        @NotNull
        public static @NotNull NSPredicate predicateForCategorySamplesEqualToValues​(@NotNull
                                                                                    @NotNull NSSet<? extends NSNumber> values)
      • predicateForWorkoutActivitiesWithOperatorTypeDuration

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithOperatorTypeDuration​(long operatorType,
                                                                                                 double duration)
      • predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeAverageQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeAverageQuantity​(long operatorType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantityType quantityType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantity averageQuantity)
      • predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeMaximumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeMaximumQuantity​(long operatorType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantityType quantityType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantity maximumQuantity)
      • predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeMinimumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeMinimumQuantity​(long operatorType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantityType quantityType,
                                                                                                                    @NotNull
                                                                                                                    @NotNull HKQuantity minimumQuantity)
      • predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeSumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithOperatorTypeQuantityTypeSumQuantity​(long operatorType,
                                                                                                                @NotNull
                                                                                                                @NotNull HKQuantityType quantityType,
                                                                                                                @NotNull
                                                                                                                @NotNull HKQuantity sumQuantity)
      • predicateForWorkoutActivitiesWithStartDateEndDateOptions

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithStartDateEndDateOptions​(@Nullable
                                                                                                    @Nullable NSDate startDate,
                                                                                                    @Nullable
                                                                                                    @Nullable NSDate endDate,
                                                                                                    long options)
      • predicateForWorkoutActivitiesWithWorkoutActivityType

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutActivitiesWithWorkoutActivityType​(long workoutActivityType)
      • predicateForWorkoutsWithActivityPredicate

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithActivityPredicate​(@NotNull
                                                                                     @NotNull NSPredicate activityPredicate)
      • predicateForWorkoutsWithOperatorTypeQuantityTypeAverageQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeQuantityTypeAverageQuantity​(long operatorType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantityType quantityType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantity averageQuantity)
      • predicateForWorkoutsWithOperatorTypeQuantityTypeMaximumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeQuantityTypeMaximumQuantity​(long operatorType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantityType quantityType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantity maximumQuantity)
      • predicateForWorkoutsWithOperatorTypeQuantityTypeMinimumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeQuantityTypeMinimumQuantity​(long operatorType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantityType quantityType,
                                                                                                           @NotNull
                                                                                                           @NotNull HKQuantity minimumQuantity)
      • predicateForWorkoutsWithOperatorTypeQuantityTypeSumQuantity

        @NotNull
        public static @NotNull NSPredicate predicateForWorkoutsWithOperatorTypeQuantityTypeSumQuantity​(long operatorType,
                                                                                                       @NotNull
                                                                                                       @NotNull HKQuantityType quantityType,
                                                                                                       @NotNull
                                                                                                       @NotNull HKQuantity sumQuantity)
      • useStoredAccessor

        @Deprecated
        public static boolean useStoredAccessor()
        Deprecated.