スタートガイド

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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

次に、以下のプロンプトを使用してください。

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

Manual セットアップを使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示に従ってください。

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層にストリーミングします。

startMeasurementUpdates()関数を呼び出してください。 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

最新の圧力サンプルのエイリアスです。

export type GetMeasurementResult = Measurement;

IsAvailableResult

クラスによって返される結果です。

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

PermissionStatus

クラスとクラスによって返される許可情報です。

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

MeasurementEvent

クラスが有効の場合に発生するイベントペイロードです。

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 がアップストリームで変更されたときは、再度同期を実行してください。

「Getting Started」から続けてください。

「Getting Started」を使用してダッシュボードと __CAPGO_KEEP_0__ の作業を計画している場合、__CAPGO_KEEP_0__ を接続してください。 「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-barometer」を使用して、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-barometer のネイティブ機能を実装してください。 「@API/__CAPGO_KEEP_1__-barometer」 「@capgo/capacitor-barometer」の実装詳細については、「capgo Overview」を参照してください。 for the native capability in Using @capgo/capacitor-barometer, API Overview API Overview 導入 導入の実装詳細のために API キー API キーの実装詳細のために、 デバイス デバイスの実装詳細のために