跳过主要内容
返回到插件
@capgo/capacitor-alarm
教程
由 github.com/Cap-go

闹钟

即使应用程序关闭,仍可安排本机闹钟和通知

指南

闹钟教程

使用@capgo/capacitor-alarm

Capacitor闹钟插件接口,用于管理本地操作系统闹钟

安装

bun add @capgo/capacitor-alarm
bunx cap sync

此插件暴露的内容

  • createAlarm - 使用平台时钟应用程序创建一个本地操作系统闹钟。 在 Android 上,这使用闹钟意图;在 iOS 上,如果可用(iOS 16+),则使用 AlarmKit。
  • openAlarms - 如果可用,打开平台的本机闹钟列表 UI。
  • getOSInfo - 获取操作系统和功能的信息。
  • requestPermissions - 在平台上请求相关的闹钟权限。 在 Android 上,可能会路由到设置精确闹钟的页面。

示例用途

createAlarm

使用平台时钟应用创建一个本机操作系统闹钟。 在 Android 上,这使用闹钟意图; 在 iOS 上,如果可用(iOS 16+),则使用 AlarmKit。

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

打开平台的本机闹钟列表 UI,如果可用。

import { CapgoAlarm } from '@capgo/capacitor-alarm';

const result = await CapgoAlarm.openAlarms();
if (result.success) {
  console.log('Alarms UI opened');
}

getOSInfo

获取有关操作系统和功能的信息。

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

在平台上请求相关的闹钟权限。 在 Android 上,可能会路由到设置精确闹钟的页面。

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');
}

完整参考