跳转到内容
Capgo - Live Updates for Capacitor Apps Capgo

开始使用

安装

Section titled “安装”
Terminal window
npm install @capgo/capacitor-alarm
npx cap sync

要求

Section titled “要求”
  • iOS：仅支持 iOS 26+。此插件依赖于 AlarmKit API，在早期版本或框架不可用时将报告不支持。
  • Android：使用 AlarmClock intent；行为取决于默认时钟应用和 OEM 策略。

注意：此插件仅公开原生闹钟操作（创建/打开）。它不实现任何自定义的应用内闹钟调度/CRUD。

API

Section titled “API”

createAlarm(…)

Section titled “createAlarm(…)”
createAlarm(options: NativeAlarmCreateOptions) => Promise<NativeActionResult>

使用平台时钟应用创建原生操作系统闹钟。 在 Android 上使用 Alarm Clock intent；在 iOS 上如果可用（iOS 26+）则使用 AlarmKit。

参数类型
optionsNativeAlarmCreateOptions

返回： Promise<NativeActionResult>

openAlarms()

Section titled “openAlarms()”
openAlarms() => Promise<NativeActionResult>

打开平台的原生闹钟列表 UI（如果可用）。

返回： Promise<NativeActionResult>

getOSInfo()

Section titled “getOSInfo()”
getOSInfo() => Promise<OSInfo>

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

返回： Promise<OSInfo>

requestPermissions(…)

Section titled “requestPermissions(…)”
requestPermissions(options?: { exactAlarm?: boolean | undefined; } | undefined) => Promise<PermissionResult>

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

参数类型
options{ exactAlarm?: boolean; }

返回： Promise<PermissionResult>

接口

Section titled “接口”

NativeActionResult

Section titled “NativeActionResult”
属性类型
successboolean
messagestring

NativeAlarmCreateOptions

Section titled “NativeAlarmCreateOptions”

通过平台时钟应用创建原生操作系统闹钟的选项。

属性类型描述
hournumber24 小时制的小时（0-23）
minutenumber小时的分钟（0-59）
labelstring闹钟的可选标签
skipUiboolean仅限 Android：如果可能，尝试跳过 UI
vibrateboolean仅限 Android：设置闹钟振动

OSInfo

Section titled “OSInfo”

返回有关当前操作系统和功能的信息。

属性类型描述
platformstring’ios’ | ‘android’ | ‘web’
versionstring操作系统版本字符串
supportsNativeAlarmsboolean平台是否公开原生闹钟应用集成
supportsScheduledNotificationsboolean是否支持调度本地通知
canScheduleExactAlarmsboolean仅限 Android：是否允许精确闹钟

PermissionResult

Section titled “PermissionResult”

权限请求的结果。

属性类型描述
grantedboolean请求范围的总体授权
detailsRecord<string, boolean>按权限键的可选详细信息