Lebih lanjut ke konten utama
@capgo/capacitor-alarm API Perangkat Terbuka Sumber

Alarm Plugin Capacitor

Jadwalkan Alarm dan Notifikasi Asli Bahkan Ketika Aplikasi Ditutup

Install

bun add @capgo/capacitor-alarm bunx cap sync
npm, pnpm atau yarn
  • npm install @capgo/capacitor-alarm
  • pnpm add @capgo/capacitor-alarm
  • yarn add @capgo/capacitor-alarm

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.

FAQ

FAQ plugin Alarm

Bagaimana cara menginstal plugin Alarm di sebuah aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-alarm" (atau "npm install @capgo/capacitor-alarm"), kemudian jalankan "bunx cap sync" agar projek iOS dan Android dapat menangkap native code. Import dari "@capgo/capacitor-alarm" di aplikasi code.

Apakah @capgo/capacitor-alarm dapat berjalan dengan React, Vue, dan Angular?

Ya. Alarm adalah sebuah paket Capacitor, sehingga dapat berjalan dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript biasa.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-alarm?

Plugin Capgo mengikuti versi utama Capacitor: gunakan versi plugin utama yang sesuai dengan versi utama Capacitor (misalnya plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub menampilkan versi yang masih dipelihara.

Apakah @capgo/capacitor-alarm gratis dan sumber terbuka?

Ya. Sumber code tersedia secara publik di GitHub di https://github.com/Cap-go/capacitor-alarm/ dan paket dapat diinstal secara gratis dari npm. Laporan bug dan permintaan pull selalu welcome.

Apakah saya dapat memperbarui code yang menggunakan Alarm tanpa tinjauan App Store?

Pemasangan atau pembaruan plugin mengubah native code, sehingga memerlukan build toko baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin dapat berlayar segera dengan Capgo live updates.

Kirimkan perubahan Alarm tanpa menunggu tinjauan aplikasi

Setelah plugin masuk dalam toko aplikasi Anda, Capgo pembaruan hidup memindahkan perubahan JavaScript, HTML, dan CSS Anda ke pengguna dalam menit.

Mulai dengan Capgo