添加日历日常信息 - addCalendarEvent

简介

• 该任务是一个异步任务，需使用async await / promise结构 获取回调值
• 该任务用于添加日历日程信息，可设置让APP进行提前提醒，类似备忘录一样的日程信息

环境适配说明

环境名称	是否支持	jssdk文件最低版本号	npm包最低版本号
湘易办APP-小程序	✅	2.0.10	0.0.17
湘易办APP-小程序-webview	✅	2.0.10	0.0.17
湘易办APP-webview	✅	2.0.10	0.0.17
三方H5	❌	--	--
三方小程序	❌	--	--

参数

参数名	类型	必填	描述
title	String	是	日程名称
startTime	Timestamp	是	开始时间 （时间戳）
endTime	Timestamp	是	结束时间 （时间戳）
reminderTime	Number	否	距离日程开始前 x 分钟 执行提醒 (默认不提醒)

返回值

仅列出返回值的子参数，整体是一个Object对象

参数名	类型	描述
isSuccess	Boolean	添加日程信息是否成功
eventID	String	日程ID
errorMsg	String	错误消息内容

示例

async & await 模式

const res = await this.$xybAgent.addCalendarEvent({
  title: '2026元旦',
  startTime: new Date('2026/01/01 00:00:00').getTime(),
  endTime: new Date('2026/01/01 23:59:59').getTime(),
  reminderTime: 5
});
if (res?.isSuccess) {
  // 添加成功
}

promise 模式

this.$xybAgent.addCalendarEvent({
  title: '2026元旦',
  startTime: new Date('2026/01/01 00:00:00').getTime(),
  endTime: new Date('2026/01/01 23:59:59').getTime(),
  reminderTime: 5
}).then(res => {
  if (res?.isSuccess) {
    // 添加成功
  }
});

注意事项

• reminderTime 为非必填字段，若业务侧不传递，标识这个日程可无需APP执行提醒动作
• reminderTime 默认是不提醒，若业务侧需要执行提醒，需要传递该值