> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# addPhoneCalendar

向系统日历添加事件。

## 扫码预览

![扫码预览 addPhoneCalendar](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fadd-phone-calendar%252Findex)

## 支持版本

前端库版本不低于 `0.0.19`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 接入准备

### 权限要求

<table>
<thead>
<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td>应用权限</td><td><code>scope.addPhoneCalendar</code></td><td>必须</td><td>Android、iOS</td><td>需要在 manifest 中声明 scope.addPhoneCalendar，并由用户授权写入系统日历。</td></tr>
</tbody>
</table>

### 授权行为

- **Android**：首次调用会依次申请应用日历授权和系统日历读写权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。
- **iOS**：首次调用会依次申请应用日历授权和系统日历写入权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。

### 前置条件

- **iOS**：设备需要存在可写入的系统日历账户

## 使用说明

- startTime、endTime 使用 Unix 秒级时间戳；alarmOffset 单位为秒，Android 系统日历提醒粒度会按分钟处理。

## 调用方式

### 异步 API

```typescript
addPhoneCalendar(params: AddPhoneCalendarParams): Promise<object>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>alarm</code></td><td><code>boolean</code></td><td>否</td><td><code>true</code></td><td>-</td><td>是否提醒。</td></tr>
<tr><td><code>alarmOffset</code></td><td><code>number</code></td><td>否</td><td><code>0</code></td><td>-</td><td>提前提醒时间，单位秒。0 表示开始时提醒。</td></tr>
<tr><td><code>allDay</code></td><td><code>boolean</code></td><td>否</td><td><code>false</code></td><td>-</td><td>是否为全天事件。</td></tr>
<tr><td><code>description</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件描述。</td></tr>
<tr><td><code>endTime</code></td><td><code>number</code></td><td>否</td><td><code>startTime</code></td><td>-</td><td>结束时间的 Unix 秒级时间戳。</td></tr>
<tr><td><code>location</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件位置。</td></tr>
<tr><td><code>path</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>跳转链接或客户端路由。传入后按原值追加到日历备注。</td></tr>
<tr><td><code>startTime</code></td><td><code>number</code></td><td>是</td><td>-</td><td>-</td><td>开始时间的 Unix 秒级时间戳。</td></tr>
<tr><td><code>title</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>日历事件标题。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import { addPhoneCalendar } from '@doubao-dev/framework/api';

const startTime = Math.floor(Date.now() / 1000) + 3600;

await addPhoneCalendar({
  title: '项目评审',
  startTime,
  endTime: startTime + 1800,
  alarm: true,
  alarmOffset: 300
});
```

## 成功返回

无返回字段。
