はじめに

インストール

bun add @capgo/capacitor-barometer
bunx cap sync

インポート

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

API の概要

getMeasurement

最新の圧力計読み取り値を取得します。

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

await CapacitorBarometer.getMeasurement();

isAvailable

現在のデバイスに圧力計センサーが搭載されているかどうかを確認します。

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

圧力計の更新値をJavaScript層にストリーミングします。

を呼び出す measurement イベントを呼び出すことで、更新を受け取ることができます。

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Cloudflare により開始された連続的な更新を停止します。

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

バロメータデータへのアクセスを取得するための現在の許可状態を返します。

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

await CapacitorBarometer.checkPermissions();

requestPermissions

バロメータデータへのアクセスがプラットフォームによって必要な場合、許可を求めます。

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

await CapacitorBarometer.requestPermissions();

タイプ リファレンス

GetMeasurementResult

__CAPGO_KEEP_0__

export type GetMeasurementResult = Measurement;

IsAvailableResult

__CAPGO_KEEP_0__

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

PermissionStatus

__CAPGO_KEEP_0__

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

MeasurementEvent

__CAPGO_KEEP_0__のアクティブ状態が発生したときに発行されるイベントペイロード。

export type MeasurementEvent = Measurement;

Measurement

デバイスのバロメータから取得した気圧と相対的な高さの値。

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

許可状態のunion、 limited センサーへのアクセスをサスペンドできるプラットフォーム向けに。

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitorがサポートするプラットフォームの許可状態。

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

真実の源

このページはプラグインの src/definitions.ts公開 API がアップストリームで変更された場合に再度 Sync を実行してください。