抖音开放平台Logo
控制台

tt.addPhoneCalendar
收藏
我的收藏

基础库 2.52.0 开始支持本方法，这是一个异步方法。

向系统日历添加事件。

前提条件

本 API 需要用户授权方可调用，详细信息可参考用户授权

业务背景无
使用限制

该 API 必须要由用户点击触发，也就是只能在 tt.onTouchEnd 的回调里面同步调用该 API。

注意事项无
相关教程无

语法

tt.addPhoneCalendar(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
locationstring否

事件位置

2.52.0
endTimenumber否

结束时间的 unix 时间戳。默认值为 startTime 的值

2.52.0
alarmbooleantrue否

是否提醒

2.52.0
alarmOffsetnumber0否

提醒提前量（单位：秒）

2.52.0
allDaybooleanfalse否

是否全天事件

2.52.0
titlestring是

日历事件标题

2.52.0
startTimenumber是

开始时间的 unix 时间戳（1970年1月1日开始所经过的秒数，单位：秒）

2.52.0
successfunction否
接口调用成功的回调函数
2.52.0
failfunction否
接口调用失败的回调函数
2.52.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
2.52.0

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"addPhoneCalendar:ok"
2.52.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"addPhoneCalendar:fail" + 详细错误信息
2.52.0

扫码体验

请使用字节宿主APP扫码

代码示例

tt.addPhoneCalendar({
  title: "测试非重复事件",
  startTime: Date.now() / 1000,
  endTime: Date.now() / 1000 + 3600,
  alarm: false,
  location: "测试location",
  description: "测试description",
  success() {
    console.log("添加桌面成功");
  },
  fail(res) {
    console.log("添加桌面失败", err.errMsg);
  },
});