Panduan
Cara menggunakan Alarm di Capacitor
Menggunakan @capgo/capacitor-alarm
Capacitor Plugin Alarm native OS untuk mengelola alarm OS asli.
Install
bun add @capgo/capacitor-alarm
bunx cap sync
bunx cap sync Mengcopy plugin native code ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Import
import { CapgoAlarm } from '@capgo/capacitor-alarm';
Lihat API secara singkat
| Metode | Deskripsi |
|---|---|
createAlarm |
Buat alarm OS asli menggunakan aplikasi jam platform. Pada Android ini menggunakan Intent Jam Alarm; pada iOS ini menggunakan AlarmKit jika tersedia (iOS 16+). |
openAlarms |
Buka daftar UI alarm native platform, jika tersedia. |
getOSInfo |
Dapatkan informasi tentang OS dan kemampuan. |
requestPermissions |
Meminta izin yang relevan untuk penggunaan alarm di platform. Pada Android, mungkin mengarah ke pengaturan untuk alarm yang tepat. |
checkPermissions |
Minta status izin saat ini untuk akses alarm native tanpa memicu UI. Pada iOS ini melaporkan siapakah AlarmKit; pada Android ini melaporkan detail kemampuan. |
getAlarms |
Dapatkan daftar alarm yang dijadwalkan oleh aplikasi ini. Pada iOS 26+, kembali alarm dari AlarmKit. Pada Android, ini tidak didukung karena sistem tidak menyediakan API untuk mengakses alarm. |
cancelAlarm |
Batalkan alarm yang dijadwalkan dengan ID-nya. Pada iOS 26+, menghapus alarm dari AlarmKit. Pada Android/web, kembali tidak didukung. |
Contoh
createAlarm()
Create a native OS alarm using the platform clock app. On Android this uses the Alarm Clock intent; on iOS this uses AlarmKit if available (iOS 16+).
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.createAlarm({
hour: 7,
minute: 30,
label: 'Wake up',
skipUi: false,
vibrate: true
});
console.log('Alarm created:', result.success);
openAlarms()
Buka daftar alarm native platform, jika tersedia.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.openAlarms();
if (result.success) {
console.log('Alarms UI opened');
}
getOSInfo()
Buka daftar alarm native platform UI, jika tersedia.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const info = await CapgoAlarm.getOSInfo();
console.log('Platform:', info.platform);
console.log('Supports native alarms:', info.supportsNativeAlarms);
if (info.platform === 'android') {
console.log('Can schedule exact alarms:', info.canScheduleExactAlarms);
}
requestPermissions()
Meminta izin yang relevan untuk penggunaan alarm di platform. Pada Android, mungkin mengarah ke pengaturan untuk alarm yang tepat.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.requestPermissions({ exactAlarm: true });
if (result.granted) {
console.log('Permissions granted');
} else {
console.log('Permissions denied');
}
checkPermissions()
Minta status izin saat ini untuk akses alarm native tanpa memicu UI. Pada iOS ini melaporkan siapakah AlarmKit; pada Android ini melaporkan detail kemampuan.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const status = await CapgoAlarm.checkPermissions();
console.log('AlarmKit allowed?', status.details?.alarmKit);
getAlarms()
Dapatkan daftar alarm yang dijadwalkan oleh aplikasi ini. Pada iOS 26+, kembali alarm dari AlarmKit. Pada Android, ini tidak didukung karena sistem tidak menyediakan API untuk mengakses alarm.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const { alarms } = await CapgoAlarm.getAlarms();
console.log('Scheduled alarms:', alarms);
alarms.forEach(alarm => {
console.log(`Alarm ${alarm.id}: ${alarm.hour}:${alarm.minute} - ${alarm.label}`);
});
Daftar di atas menampilkan 7 metode inti. Penjelasan dan bantuan versi, serta kontrak lengkap dari setiap metode, dapat ditemukan di repository GitHub.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-alarm
Teruskan dari Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-alarm Menggunakan @capgo/capacitor-alarm hubungkan plugin native untuk perencanaan @capgo/capacitor-alarm untuk detail implementasi di @capgo/capacitor-alarm, untuk detail implementasi di @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-alarm, untuk detail implementasi di Getting Started, Daftar Direktori Plugin Capgo untuk alur kerja produk di Daftar Direktori Plugin Capgo, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, dan Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin.