# @capgo/capacitor-alarm 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-alarm/

版本：8\.1\.14
npm 元数据更新时间：2026-10-15T06:48:23.000Z
中文译文更新时间：2026-11-09T04:01:23.171Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-alarm
原文对照：https://npmcn.com/package/%40capgo/capacitor-alarm/?lang=original
项目主页：https://capgo.app/docs/plugins/alarm/
源码仓库：https://github.com/Cap-go/capacitor-alarm

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：112 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-09-15T17:47:59.516Z
- 最新版本发布：2026-10-15T06:48:22.346Z
- 近 30 天下载量：40839（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 26 个）

## 中文简介

管理本地提醒控制器插件

## 安装

```sh
npm install @capgo/capacitor-alarm
```

也可以使用：`pnpm add @capgo/capacitor-alarm`、`yarn add @capgo/capacitor-alarm`、`bun add @capgo/capacitor-alarm`

## README

# @ capgo/ 电容警报

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

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-alarm)](https://capgo.app/?ref=plugin_alarm)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_alarm)

14天无限自由审判. 不需要信用卡

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

![@capgo/capacitor-alarm for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-alarm/main/assets/github-social-preview.png)

## 主要特点

-   **本地警报**数字 : `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](https://capgo.app/docs/plugins/alarm/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

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

## 安装

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

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

然后使用下列提示:

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

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

```bash
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(...)`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-createalarm)
-   [`openAlarms()`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-openalarms)
-   [`getOSInfo()`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-getosinfo)
-   [`requestPermissions(...)`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-requestpermissions)
-   [`checkPermissions()`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-checkpermissions)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-getpluginversion)
-   [`getAlarms()`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-getalarms)
-   [`cancelAlarm(...)`](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-cancelalarm)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-type-aliases)

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

### 创建提醒(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[NativeAlarmCreateOptions](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-nativealarmcreateoptions)` | \- 创建提醒的选项 |

**回返情况:** `Promise<[NativeActionResult](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-nativeactionresult)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 打开提醒( A)

```typescript
openAlarms() => Promise<NativeActionResult>
```

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

**回返情况:** `Promise<[NativeActionResult](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-nativeactionresult)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 获取OSInfo ()

```typescript
getOSInfo() => Promise<OSInfo>
```

获取OS的信息和能力.

**回返情况:** `Promise<[OSInfo](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-osinfo)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 请求(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `{ exactAlarm?: boolean; }` | \- 许可请求的可选参数 |

**回返情况:** `Promise<[PermissionResult](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-permissionresult)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 检查( )

```typescript
checkPermissions() => Promise<PermissionResult>
```

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

**回返情况:** `Promise<[PermissionResult](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-permissionresult)>`

**自:** 8.0.4 国家

* * *

### 获取 PluginVersion ()

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

获取本地 Capacitor 插件版本 .

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

**自:** 1.0.0 (单位:千美元)

* * *

### 获取提醒( A)

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

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

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

**自:** 1.1.0 国家

* * *

### 取消提醒(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `{ id: string; }` | \- 包含要取消的提醒ID的选项 |

**回返情况:** `Promise<[NativeActionResult](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-nativeactionresult)>`

**自:** 8.1.0 联合国

* * *

### 接口

#### 土著行动结果

本地行动的结果.

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`success`** | `boolean` | 行动是否成功 |
| **`message`** | `string` | 附加信息的可选消息 |
| **`id`** | `string` | 可选提醒 ID( 通过创建提醒返回到 iOS) |

#### 本地提醒创建选项

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

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`hour`** | `number` | 24小时(0-23) |
| **`minute`** | `number` | 小时分钟(0-59) |
| **`label`** | `string` | 提醒的可选标签 |
| **`skipUi`** | `boolean` | 仅限Android:如果可能,尝试跳过UI |
| **`vibrate`** | `boolean` | 只有Android: 设置提醒以震动 |

#### OSInfo 数据

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

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`platform`** | `string` | 平台标识符 : “ ios ” “android ” “ 网络 ” |
| **`version`** | `string` | OS 版本字符串 |
| **`supportsNativeAlarms`** | `boolean` | 平台是否曝光本地提醒应用程序集成 |
| **`supportsScheduledNotifications`** | `boolean` | 是否支持本地通知列表 |
| **`canScheduleExactAlarms`** | `boolean` | 仅限Android:是否允许精确的提醒 |

#### 权限释放

权限请求的结果 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`granted`** | `boolean` | 申请范围的赠款总额 |
| **`details`** | `[Record](https://npmcn.com/package/%40capgo/capacitor-alarm/#readme-record)<string, boolean>` | 通过权限密钥选择细节 |
| **`message`** | `string` | 可选择的人类可读诊断 |

#### 提醒信息

关于预定警报的信息.

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`id`** | `string` | 提醒的独特标识符 |
| **`hour`** | `number` | 24h格式的小时(0-23). 在此插件之外创建的提醒可能不存在 . |
| **`minute`** | `number` | 时分(0-59). 在此插件之外创建的提醒可能不存在 . |
| **`label`** | `string` | 提醒的可选标签 |
| **`enabled`** | `boolean` | 是否启用提醒 |

### 类型异名

#### 记录

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

`{ [P in K]: T; }`

## 常见问题

### @capgo/capacitor-alarm 是什么？

管理本地提醒控制器插件

### 如何安装 @capgo/capacitor-alarm？

在项目目录运行 npm install @capgo/capacitor-alarm，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-alarm 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-alarm 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-alarm 可以商用吗？

@capgo/capacitor-alarm 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-alarm 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-alarm 在 2026/10/09 – 2026/11/07 这 30 天内被下载 40,839 次，日均约 1,361 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-alarm 还在维护吗？

最新版本 8\.1\.14 发布于 2026/10/15（25 天前）；至今共发布 63 个版本，其中过去 12 个月发布了 26 个；首次发布于 2025/09/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。