Memulai

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-alarm`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/id/docs/plugins/alarm/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instalasi

npm install @capgo/capacitor-alarm
npx cap sync

yarn add @capgo/capacitor-alarm
npx cap sync

pnpm add @capgo/capacitor-alarm
npx cap sync

bun add @capgo/capacitor-alarm
npx cap sync

Persyaratan

iOS: Hanya iOS 26+. Plugin ini bergantung pada AlarmKit API dan akan melaporkan tidak didukung di versi sebelumnya atau ketika framework tidak tersedia.
Android: Menggunakan intent AlarmClock; perilaku tergantung pada aplikasi Clock default dan kebijakan OEM.

Catatan: Plugin ini hanya mengekspos aksi alarm native (create/open). Plugin ini tidak mengimplementasikan penjadwalan/CRUD alarm in-app kustom.

API

createAlarm(…)

createAlarm(options: NativeAlarmCreateOptions) => Promise<NativeActionResult>

Buat alarm OS native menggunakan aplikasi clock platform. Di Android ini menggunakan intent Alarm Clock; di iOS ini menggunakan AlarmKit jika tersedia (iOS 26+).

Param	Type
`options`	`NativeAlarmCreateOptions`

Mengembalikan: Promise<NativeActionResult>

openAlarms()

openAlarms() => Promise<NativeActionResult>

Buka UI daftar alarm native platform, jika tersedia.

Mengembalikan: Promise<NativeActionResult>

getOSInfo()

getOSInfo() => Promise<OSInfo>

Dapatkan informasi tentang OS dan kemampuannya.

Mengembalikan: Promise<OSInfo>

requestPermissions(…)

requestPermissions(options?: { exactAlarm?: boolean | undefined; } | undefined) => Promise<PermissionResult>

Minta izin yang relevan untuk penggunaan alarm di platform. Di Android, dapat mengarahkan ke pengaturan untuk alarm exact.

Param	Type
`options`	`{ exactAlarm?: boolean; }`

Mengembalikan: Promise<PermissionResult>

Interface

NativeActionResult

Prop	Type
`success`	`boolean`
`message`	`string`

NativeAlarmCreateOptions

Opsi untuk membuat alarm OS native melalui aplikasi clock platform.

Prop	Type	Description
`hour`	`number`	Jam dalam format 24 jam (0-23)
`minute`	`number`	Menit dalam jam (0-59)
`label`	`string`	Label opsional untuk alarm
`skipUi`	`boolean`	Khusus Android: upayakan melewati UI jika memungkinkan
`vibrate`	`boolean`	Khusus Android: atur alarm untuk bergetar

OSInfo

Informasi yang dikembalikan tentang OS saat ini dan kemampuannya.

Prop	Type	Description
`platform`	`string`	’ios’ \| ‘android’ \| ‘web’
`version`	`string`	String versi OS
`supportsNativeAlarms`	`boolean`	Apakah platform mengekspos integrasi aplikasi alarm native
`supportsScheduledNotifications`	`boolean`	Apakah penjadwalan notifikasi lokal didukung
`canScheduleExactAlarms`	`boolean`	Khusus Android: apakah alarm exact diizinkan

PermissionResult

Hasil dari permintaan izin.

Prop	Type	Description
`granted`	`boolean`	Izin keseluruhan untuk ruang lingkup yang diminta
`details`	`Record<string, boolean>`	Detail opsional berdasarkan kunci izin