Panduan
Cara menggunakan Alarm di Capacitor
Menggunakan @capgo/capacitor-alarm
Interface plugin Capacitor Alarm untuk mengelola alarm native OS.
Instal
bun add @capgo/capacitor-alarm
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { CapgoAlarm } from '@capgo/capacitor-alarm';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
createAlarm |
Buat alarm OS native menggunakan aplikasi jam bawaan platform. Di Android ini memakai intent Alarm Clock; di iOS memakai AlarmKit jika tersedia (iOS 16+). |
openAlarms |
Buka UI daftar alarm native platform, jika tersedia. |
getOSInfo |
Dapatkan informasi tentang OS dan kemampuannya. |
requestPermissions |
Minta izin yang diperlukan untuk penggunaan alarm di platform. Di Android, mungkin diarahkan ke pengaturan untuk exact alarm. |
checkPermissions |
Cek status izin saat ini untuk akses alarm native tanpa memicu UI. Di iOS ini melaporkan kesiapan AlarmKit; di Android melaporkan detail kapabilitas. |
getAlarms |
Dapatkan daftar alarm yang dijadwalkan oleh aplikasi ini. Di iOS 26+, mengembalikan alarm dari AlarmKit. Di Android, ini tidak didukung karena sistem tidak menyediakan API untuk query alarm. |
cancelAlarm |
Batalkan alarm terjadwal berdasarkan ID-nya. Di iOS 26+, alarm dihapus dari AlarmKit. Di Android/web, akan mengembalikan not supported. |
Contoh
createAlarm()
Buat alarm OS native menggunakan aplikasi jam bawaan platform. Di Android ini memakai intent Alarm Clock; di iOS memakai AlarmKit jika tersedia (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 UI 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()
Dapatkan informasi tentang OS dan kemampuannya.
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()
Minta izin yang diperlukan untuk penggunaan alarm di platform. Di Android, mungkin diarahkan ke pengaturan untuk exact alarm.
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()
Cek status izin saat ini untuk akses alarm native tanpa memicu UI. Di iOS ini melaporkan kesiapan AlarmKit; di Android melaporkan detail kapabilitas.
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. Di iOS 26+, mengembalikan alarm dari AlarmKit. Di Android, ini tidak didukung karena sistem tidak menyediakan API untuk query 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}`);
});
Tabel di atas mencantumkan 7 metode inti. Listener, helper versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-alarm
Jika Anda menggunakan Menggunakan @capgo/capacitor-alarm untuk merencanakan pekerjaan plugin native, hubungkan dengan @capgo/capacitor-alarm untuk detail implementasi di @capgo/capacitor-alarm, Panduan Memulai untuk detail implementasi di Getting Started, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh Capgo, dan Menambahkan atau Memperbarui Plugin untuk detail implementasi di bagian Menambahkan atau Memperbarui Plugin.