「Getting Started」

インストール

Capgoの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 Setup を使用する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム固有の手順に従ってください。

bun add @capgo/capacitor-barometer
bunx cap sync

インポート

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

API の概要

getMeasurement

最新のバラメーター値を取得します。

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

const result = await CapacitorBarometer.getMeasurement();
console.log(result);

isAvailable

現在のデバイスが加速度計センサを備えているかどうかを確認します。

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

const result = await CapacitorBarometer.isAvailable();
console.log(result);

startMeasurementUpdates

JavaScript層に加速度計の更新をストリーミングします。

を呼び出して、 measurement 更新を受け取るイベントを取得します。

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

を呼び出して、開始した連続的な更新を停止します。

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

バロメータデータへのアクセス権の現在の状態を取得します。

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

const result = await CapacitorBarometer.checkPermissions();
console.log(result);

requestPermissions

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

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

const result = await CapacitorBarometer.requestPermissions();
console.log(result);

タイプ リファレンス

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.tspublic APIがアップストリームで変更されたときに再度Syncを実行してください

Getting Startedから続けて

Capgoを使用している場合 はじめに ダッシュボードとAPIの作業を計画するには Capgoを使用して@capgo/capacitor-barometer Capgoを使用して@capgo/capacitor-barometerのネイティブ機能 APIの概要 APIの実装詳細 導入 導入の実装詳細 APIのキー APIの実装詳細 デバイス デバイスの実装詳細について。