Langsung ke isi

Mulai Menggunakan

GitHub

Anda dapat menggunakan Setup Bantuan AI kami untuk menginstal plugin ini. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Kemudian gunakan prompt berikut:

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

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah:

Tampilan jendela terminal
bun add @capgo/capacitor-proximity
bunx cap sync
import { CapacitorProximity } from '@capgo/capacitor-proximity';

Bab berjudul “API Overview”

Ringkasan berjudul "API Pengantar"

Mengaktifkan pemantauan keberadaan.

On iOS ini memungkinkan UIDevice.isProximityMonitoringEnabled. Di Android ini mulai mendengarkan ke TYPE_PROXIMITY dan menurunkan jendela aplikasi saat ini sementara sensor tertutup.

import { CapacitorProximity } from '@capgo/capacitor-proximity';
await CapacitorProximity.enable();

Bagian berjudul “disable”

Mengembalikan perilaku jendela aplikasi default dan menghentikan pemantauan sensor.

import { CapacitorProximity } from '@capgo/capacitor-proximity';
await CapacitorProximity.disable();

Periksa ketersediaan sensor saat ini dan status plugin yang diaktifkan.

import { CapacitorProximity } from '@capgo/capacitor-proximity';
const status = await CapacitorProximity.getStatus();

ProximityStatusResult

Referensi Status Proksimitas

Hasil yang dikembalikan oleh getStatus().

export interface ProximityStatusResult {
/**
* Whether the current device exposes a usable proximity sensor.
*
* @since 0.0.1
*/
available: boolean;
/**
* Whether proximity monitoring is currently enabled by the plugin.
*
* @since 0.0.1
*/
enabled: boolean;
/**
* Platform label returned by the native or web implementation.
*
* @since 0.0.1
*/
platform: 'ios' | 'android' | 'web';
}

Hasil yang dikembalikan ketika meminta versi plugin.

export interface PluginVersionResult {
/**
* Native plugin version string.
*
* @since 0.0.1
*/
version: string;
}

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika publik API berubah di atas.

Jika Anda menggunakan Mulai Menggunakan untuk merencanakan dashboard dan operasi API, hubungkannya dengan Menggunakan @capgo/capacitor-proximity untuk kemampuan asli dalam Menggunakan @capgo/capacitor-proximity, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi dalam Pendahuluan, Kunci API untuk detail implementasi dalam Kunci API, dan Perangkat untuk detail implementasi di Perangkat.