Getting Started

Installieren

bun add @capgo/capacitor-barometer
bunx cap sync

Importieren

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

API Übersicht

getMeasurement

Hol dir die neueste Barometer-Lese, die vom native Layer erfasst wurde.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.getMeasurement();

isAvailable

Überprüfe, ob das aktuelle Gerät einen Barometer-Sensor enthält.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Beginne mit dem Streamen von Barometer-Updates in die JavaScript-Schicht.

Rufe mit dem measurement ereignis auf, um die Updates zu erhalten.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Stoppe die kontinuierlichen Updates, die über . gestartet wurden.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Zustand der Berechtigung zurück, um Zugriff auf Daten des Barometers zu erhalten.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.checkPermissions();

requestPermissions

Berechtigung zum Zugriff auf Barometerdaten anfordern, wenn dies durch die Plattform erforderlich ist.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.requestPermissions();

Typenreferenz

GetMeasurementResult

Alias für das kürzlichste Druckproben-Beispiel.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergibt zurück, ob verfügbar ist.

export interface IsAvailableResult {
  /**
   * Indicates whether the device exposes a barometer sensor.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

Zurückgegebene Berechtigungsinformationen durch und .

export interface PermissionStatus {
  /**
   * The permission state for accessing barometer measurements on the current platform.
   *
   * @since 1.0.0
   */
  barometer: BarometerPermissionState;
}

MeasurementEvent

Ereignis-Payload, die bei Aktivierung von ausgestoßen wird.

export type MeasurementEvent = Measurement;

Measurement

Luftdruck- und relative Höhenwerte, die von dem Gerätebarometer abgeleitet werden.

export interface Measurement {
  /**
   * The static air pressure in hectopascals (hPa).
   *
   * @since 1.0.0
   */
  pressure: number;

  /**
   * The change in altitude relative to the time updates started.
   * Only available on iOS; Android will always return `0`.
   *
   * @since 1.0.0
   */
  relativeAltitude: number;

  /**
   * The timestamp of the measurement in milliseconds since the Unix epoch.
   *
   * @since 1.0.0
   */
  timestamp: number;
}

BarometerPermissionState

Einheitliche Zustände für die Berechtigung, einschließlich limited für Plattformen, die den Zugriff auf Sensoren drosseln können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Berechtigungsstatus der Plattform, die von Capacitor unterstützt werden.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Quellcode ändert, führen Sie die Synchronisierung erneut durch.

Weitermachen von Getting Started

Wenn Sie " Getting Started um ein Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-Barometer für die native Fähigkeit in Mit @capgo/capacitor-Barometer, 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üsseln und Geräte für die Implementierungsdetails in Geräten.