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, and this page is available as Markdown at /apps-plugin/docs/js-api/device/calendar/addPhoneRepeatCalendar.md.

addPhoneRepeatCalendar

向系统日历添加重复事件。

扫码预览

扫码预览 addPhoneRepeatCalendar

支持版本

前端库版本不低于 0.0.25。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

权限要求

类型标识是否必须平台说明
应用权限scope.addPhoneCalendar必须Android、iOS需要在 manifest 中声明 scope.addPhoneCalendar,并由用户授权写入系统日历。

授权行为

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

前置条件

  • iOS:设备需要存在可写入的系统日历账户
  • repeatInterval 为 month 时,startTime 所在日期不能大于 28 日

使用说明

  • repeatInterval 默认 month;repeatEndTime 不传表示一直重复;startTime、endTime、repeatEndTime 使用 Unix 秒级时间戳。

调用方式

异步 API

addPhoneRepeatCalendar(params: AddPhoneRepeatCalendarParams): Promise<object>

入参

名称类型必填默认值约束说明
alarmboolean否true-是否提醒。
alarmOffsetnumber否0-提前提醒时间,单位秒。0 表示开始时提醒。
allDayboolean否false-是否为全天事件。
descriptionstring否--事件描述。
endTimenumber否startTime-结束时间的 Unix 秒级时间戳。
locationstring否--事件位置。
pathstring否--跳转链接或客户端路由。传入后按原值追加到日历备注。
repeatEndTimenumber否--重复结束时间的 Unix 秒级时间戳。
repeatIntervalCalendarRepeatInterval否month-重复周期。
startTimenumber是--开始时间的 Unix 秒级时间戳。
titlestring是--日历事件标题。

调用示例

import { addPhoneRepeatCalendar } from '@doubao-dev/framework/api';

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

await addPhoneRepeatCalendar({
  title: '每周例会',
  startTime,
  endTime: startTime + 1800,
  repeatInterval: 'week'
});

成功返回

无返回字段。