跳过主要内容
返回插件
@capgo/capacitor-alarm
教程
@capgo/capacitor-alarm

闹钟

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

指南

Alarm教程

在设备上测试

Download the Capgo app, then scan the QR code.

Alarm plugin preview QR code

使用 @capgo/capacitor-alarm

Capacitor native OS alarm管理插件接口

安装

bun add @capgo/capacitor-alarm
bunx cap sync

此插件暴露的内容

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

示例使用

createAlarm

使用平台时钟应用创建本机操作系统闹钟。 在 Android 上,这使用闹钟意图; 在 iOS 上,如果可用,则使用 AlarmKit (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

打开本地平台的闹钟列表 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');
}

全局参考

继续使用 @capgo/capacitor-alarm

如果您正在使用 使用 @capgo/capacitor-alarm 来规划原生插件工作,连接它与 @capgo/capacitor-alarm 为 @capgo/capacitor-alarm 的实现细节 开始使用 为 Getting Started 的实现细节 Capgo 插件目录 为 Capgo 插件目录 中的产品工作流程 Capacitor 由 Capgo 提供的插件 为 Capacitor 由 Capgo 提供的插件 的实现细节,并且 添加或更新插件 为添加或更新插件 的实现细节