Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeug mithilfe der folgenden Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann den folgenden Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-health` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

bun add @capgo/capacitor-health
bunx cap sync

Importieren

import { Health } from '@capgo/capacitor-health';

API Übersicht

isAvailable

Gibt an, ob die aktuelle Plattform die native Gesundheitsfunktion SDK unterstützt.

import { Health } from '@capgo/capacitor-health';

await Health.isAvailable();

requestAuthorization

Bereitstellung von Leserecht und Schreibzugriff auf die bereitgestellten Datentypen.

import { Health } from '@capgo/capacitor-health';

await Health.requestAuthorization({} as AuthorizationOptions);

checkAuthorization

Überprüft die Autorisierungsstatus für die bereitgestellten Datentypen ohne den Benutzer zu fragen.

import { Health } from '@capgo/capacitor-health';

await Health.checkAuthorization({} as AuthorizationOptions);

readSamples

Liest Proben für den angegebenen Datentyp innerhalb der angegebenen Zeitraum.

import { Health } from '@capgo/capacitor-health';

await Health.readSamples({} as QueryOptions);

saveSample

Schreibt eine einzelne Probe in den native Health Store.

import { Health } from '@capgo/capacitor-health';

await Health.saveSample({} as WriteSampleOptions);

openHealthConnectSettings

Öffnet die Health Connect Einstellungen (nur Android). Bei iOS tut diese Methode nichts.

Verwenden Sie dies, um Benutzern zu leiten, ihre Health Connect Berechtigungen zu verwalten oder Health Connect zu installieren, wenn es nicht verfügbar ist.

import { Health } from '@capgo/capacitor-health';

await Health.openHealthConnectSettings();

showPrivacyPolicy

Zeigt die Datenschutzbestimmungen der App für Health Connect (nur Android). Bei iOS tut diese Methode nichts.

Dies zeigt das gleiche Datenschutzbestimmungs-Screen, das Health Connect anzeigt, als der Benutzer auf ‘Datenschutz-Bestimmungen’ in der Berechtigungs-Dialogbox klickt.

Die Datenschutzbestimmungs-URL kann konfiguriert werden, indem ein String-Ressource mit dem Namen ‘health_connect_privacy_policy_url’ in den strings.xml Ihrer App hinzugefügt wird, oder indem eine HTML-Datei in www/privacypolicy.html in Ihren Assets platziert wird.

import { Health } from '@capgo/capacitor-health';

await Health.showPrivacyPolicy();

queryWorkouts

Abruft Arbeitsausführungen aus dem nativen Gesundheits-Store. Unterstützt auf iOS (HealthKit) und Android (Health Connect).

import { Health } from '@capgo/capacitor-health';

await Health.queryWorkouts({} as QueryWorkoutsOptions);

queryAggregated

Abruft aggregierte Gesundheitsdaten aus dem nativen Gesundheits-Store. Aggregiert Daten in Zeitblöcke (Stunde, Tag, Woche, Monat) mit Operationen wie Summe, Durchschnitt, Mindestwert oder Maximum. Dies ist effizienter als das Abrufen einzelner Beispiele für große Datumsbereiche.

Unterstützt auf iOS (HealthKit) und Android (Health Connect).

import { Health } from '@capgo/capacitor-health';

await Health.queryAggregated({} as QueryAggregatedOptions);

Typenreferenz

AvailabilityResult

export interface AvailabilityResult {
  available: boolean;
  /** Platform specific details (for debugging/diagnostics). */
  platform?: 'ios' | 'android' | 'web';
  reason?: string;
}

AuthorizationOptions

export interface AuthorizationOptions {
  /** Data types that should be readable after authorization. */
  read?: HealthDataType[];
  /** Data types that should be writable after authorization. */
  write?: HealthDataType[];
}

AuthorizationStatus

export interface AuthorizationStatus {
  readAuthorized: HealthDataType[];
  readDenied: HealthDataType[];
  writeAuthorized: HealthDataType[];
  writeDenied: HealthDataType[];
}

QueryOptions

export interface QueryOptions {
  /** The type of data to retrieve from the health store. */
  dataType: HealthDataType;
  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */
  startDate?: string;
  /** Exclusive ISO 8601 end date (defaults to now). */
  endDate?: string;
  /** Maximum number of samples to return (defaults to 100). */
  limit?: number;
  /** Return results sorted ascending by start date (defaults to false). */
  ascending?: boolean;
}

ReadSamplesResult

export interface ReadSamplesResult {
  samples: HealthSample[];
}

WriteSampleOptions

export interface WriteSampleOptions {
  dataType: HealthDataType;
  value: number;
  /**
   * Optional unit override. If omitted, the default unit for the data type is used
   * (count for `steps`, meter for `distance`, kilocalorie for `calories`, bpm for `heartRate`, kilogram for `weight`).
   */
  unit?: HealthUnit;
  /** ISO 8601 start date for the sample. Defaults to now. */
  startDate?: string;
  /** ISO 8601 end date for the sample. Defaults to startDate. */
  endDate?: string;
  /** Metadata key-value pairs forwarded to the native APIs where supported. */
  metadata?: Record<string, string>;
  /** For blood pressure data, the systolic value in mmHg. Required when dataType is 'bloodPressure'. */
  systolic?: number;
  /** For blood pressure data, the diastolic value in mmHg. Required when dataType is 'bloodPressure'. */
  diastolic?: number;
}

QueryWorkoutsOptions

export interface QueryWorkoutsOptions {
  /** Optional workout type filter. If omitted, all workout types are returned. */
  workoutType?: WorkoutType;
  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */
  startDate?: string;
  /** Exclusive ISO 8601 end date (defaults to now). */
  endDate?: string;
  /** Maximum number of workouts to return (defaults to 100). */
  limit?: number;
  /** Return results sorted ascending by start date (defaults to false). */
  ascending?: boolean;
  /**
   * Anchor for pagination. Use the anchor returned from a previous query to continue from that point.
   * On iOS, this is the ISO 8601 cursor returned by the previous query. On Android, this uses
   * Health Connect's pageToken.
   * Omit this parameter to start from the beginning.
   */
  anchor?: string;
}

QueryWorkoutsResult

export interface QueryWorkoutsResult {
  workouts: Workout[];
  /**
   * Anchor for the next page of results. Pass this value as the anchor parameter in the next query
   * to continue pagination. If undefined or null, there are no more results.
   */
  anchor?: string;
}

QueryAggregatedOptions

export interface QueryAggregatedOptions {
  /** The type of data to aggregate from the health store. */
  dataType: HealthDataType;
  /** Inclusive ISO 8601 start date (defaults to now - 1 day). */
  startDate?: string;
  /** Exclusive ISO 8601 end date (defaults to now). */
  endDate?: string;
  /** Time bucket for aggregation (defaults to 'day'). */
  bucket?: BucketType;
  /** Aggregation operation to perform (defaults to 'sum'). */
  aggregation?: AggregationType;
}

QueryAggregatedResult

export interface QueryAggregatedResult {
  samples: AggregatedSample[];
}

HealthDataType

export type HealthDataType =
  | 'steps'
  | 'distance'
  | 'calories'
  | 'heartRate'
  | 'weight'
  | 'sleep'
  | 'respiratoryRate'
  | 'oxygenSaturation'
  | 'restingHeartRate'
  | 'heartRateVariability'
  | 'bloodPressure'
  | 'bloodGlucose'
  | 'bodyTemperature'
  | 'height'
  | 'flightsClimbed'
  | 'exerciseTime'
  | 'distanceCycling'
  | 'bodyFat'
  | 'basalBodyTemperature'
  | 'basalCalories'
  | 'totalCalories'
  | 'mindfulness'
  | 'workouts';

HealthSample

export interface HealthSample {
  dataType: HealthDataType;
  value: number;
  unit: HealthUnit;
  startDate: string;
  endDate: string;
  sourceName?: string;
  sourceId?: string;
  /** Platform-specific unique identifier (HealthKit UUID on iOS, Health Connect metadata ID on Android). */
  platformId?: string;
  /** For sleep data, indicates the sleep state (e.g., 'asleep', 'awake', 'rem', 'deep', 'light'). */
  sleepState?: SleepState;
  /** For blood pressure data, the systolic value in mmHg. */
  systolic?: number;
  /** For blood pressure data, the diastolic value in mmHg. */
  diastolic?: number;
}

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie " Getting Started" zum Planen von Dashboard und __CAPGO_KEEP_0__-Operationen verwenden, verbinden Sie es mit Mit @API/__CAPGO_KEEP_1__-health Using @capgo/capacitor-health für die native Fähigkeit in @capgo/capacitor-Gesundheit, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.