@ capgo/ 电容警报

在您的 Capacitor app 的系统时钟中创建真实的提醒: iOS 26 上的提醒 Kit 以及 Android 上的提醒时钟意图 。 警报和提醒程序会像内置时钟一样发出警报.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-alarm 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/电容-警报器到我的电容软件上并把它接通 代理设置指南 • 妇女 主机磁共振

主要特点

• 本地警报数字 : createAlarm() 通过alarmKit在iOS 26上和后期,或通过Android上的平台时钟应用来添加提醒.
• 提醒列表数字 : openAlarms() 打开可用的系统提醒 UI .
• 管理 iOS数字 : getAlarms() 财务报告和审定财务报表 cancelAlarm() 列表并删除您的应用程序在 iOS 26 上和之后创建的提醒.
• 能力数字 : getOSInfo() 报告当前操作系统支持的内容.
• 权限数字 : checkPermissions() 财务报告和审定财务报表 requestPermissions()包括Android的精确警报.
• 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. 列出和取消提醒只是 iOS 。 在网上不可用.

为什么是警报器?

执行此程序的唯一插件 最新本地提醒 API 用于iOS和Android:

• iOS 26+ 报警Kit - 与苹果公司新的警报框架全面整合
• Android 提醒钟意图 - 现代警报管理遵循OEM政策
• 绝后 - 建在最新的平台API上,而不是贬值的方法
• 跨平台 - 一致的API跨iOS和Android

对于闹钟应用,提醒应用,药物追踪器,以及任何需要本地系统警报的应用软件,都是必不可少的.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/alarm/ 互联网档案馆的存檔,存档日期2013-12-02

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-alarm` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-alarm
npx cap sync

所需资源

• iOS:iOS 26+仅限. 此插件依赖 AlarmKit APIs 并将不支持前几个版本或当框架不可用时报告.
• 安卓:用途 AlarmClock 意图;行为取决于默认时钟应用和OEM政策.

注意: 此插件只会暴露本地提醒动作( 创建/ 打开) 。 它没有执行任何自定义的应用中的提醒调度/ CRUD .

权限检查

使用 CapgoAlarm.checkPermissions() 以询问提醒Kit(iOS)或平台时钟集成(Android)是否在提示用户之前就已准备好。 该方法从未打开系统 UI并返回 a PermissionResult 与 details 描述特定平台状态(例如, { alarmKit: true } 在iOS上或 { exactAlarm: false } 在Android 12+上).

如果您的本地运行时间是旧的这个插件, 它早于 checkPermissions 桥, JavaScript shim 解决 { granted: false, message: 'CapgoAlarm.checkPermissions is not implemented...' } 这样你就可以优雅地回归到特性检测或者请求更新.

API 密码

• createAlarm(...)
• openAlarms()
• getOSInfo()
• requestPermissions(...)
• checkPermissions()
• getPluginVersion()
• getAlarms()
• cancelAlarm(...)
• 接口
• 类型异名

用于管理本地OS提醒的 Capacitor 提醒插件接口 .

创建提醒(...)

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

使用平台时钟应用创建本地OS提醒. 在Android上,它使用提醒钟的意向;在iOS上,它如果可用(iOS 16+)则使用提醒 Kit.

回返情况: Promise<NativeActionResult>

自: 1.0.0 (单位:千美元)

打开提醒( A)

openAlarms() => Promise<NativeActionResult>

打开平台的本地提醒列表 UI, 如果可用的话.

回返情况: Promise<NativeActionResult>

自: 1.0.0 (单位:千美元)

获取OSInfo ()

getOSInfo() => Promise<OSInfo>

获取OS的信息和能力.

回返情况: Promise<OSInfo>

自: 1.0.0 (单位:千美元)

请求(...)

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

请求相关权限用于平台上的提醒使用. 在Android上,可能路径到设置以获取精确的警报.

回返情况: Promise<PermissionResult>

自: 1.0.0 (单位:千美元)

检查( )

checkPermissions() => Promise<PermissionResult>

检查当前本地提醒访问的权限状态而不触发 UI . 在iOS上,报告AlmarmKit准备状态;在Android上,报告能力细节.

回返情况: Promise<PermissionResult>

自: 8.0.4 国家

获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本 .

回返情况: Promise<{ version: string; }>

自: 1.0.0 (单位:千美元)

获取提醒( A)

getAlarms() => Promise<{ alarms: AlarmInfo[]; message?: string; }>

获取此应用程序安排的提醒列表 . 在 iOS 26+ 上,从 AlarmKit 返回提醒. 在Android上,这个不支持 由于系统不提供查询提醒的API.

回返情况: Promise<{ alarms: AlarmInfo[]; message?: string; }>

自: 1.1.0 国家

取消提醒(...)

cancelAlarm(options: { id: string; }) => Promise<NativeActionResult>

取消预定的提醒 . 在 iOS 26+ 上,从 AlarmKit 中删除提醒. 在Android/web上,返回不支持.

回返情况: Promise<NativeActionResult>

自: 8.1.0 联合国

接口

土著行动结果

本地行动的结果.

本地提醒创建选项

通过平台时钟应用创建本地OS提醒的选项.

OSInfo 数据

返回关于当前操作系统和能力的信息.

权限释放

权限请求的结果 .

提醒信息

关于预定警报的信息.

类型异名

记录

构造 T 类型 K 的一组属性类型

{ [P in K]: T; }