更新记录

1.0.0（2023-08-18）

实现iOS平台日历事件提醒功能

平台兼容性

uni-app

uni-app x

xwe-calendar（日历事件提醒插件）

HBuilder X 版本支持

语言版本兼容

平台兼容

权限说明文档

【ios】

未内置注册权限：下面的权限是要自己在项目中配置的，如下：

NSCalendarsUsageDescription 日历权限

接口使用文档

• 引入插件和实例化

【用的ts语法，非ts自行转换】

import {XWECalendar} from '@/uni_modules/xwe-calendar';

let xweCalendar:XWECalendar = new XWECalendar();

• 初始化插件

xweCalendar.initCalendar(callback)

说明：插件必须先初始化，否则无法使用日历相关的api

callback返回参数说明

callbackOption结构说明

• 请求日历权限

xweCalendar.requestAccess(callback)

说明：权限不满足无法使用日历相关的api

callback返回参数说明

callbackOption结构说明

• 创建日历事件提醒

xweCalendar.createCalendarEvent(option)

option结构说明

callback返回参数说明

callbackOption结构说明

data结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xweCalendar.createCalendarEvent({
    title:'事件提醒标题',
    notes:'事件提醒备注',
    repeatReminder:5,
    repeatFrequency:0,
    reminderTime:0,
    startYear:2023,
    startMonth:8,
    startDay:17,
    startHour:11,
    startMinute:5,
    endYear:2023,
    endMonth:8,
    endDay:17,
    endHour:11,
    endMinute:10,
    callback:(callBackOption:Object) => {
        if(callBackOption.code == 4){
            let dataObj:Object = callBackOption.data ? JSON.parse(callBackOption.data) : {};

            console.log('创建事件-成功',callBackOption,dataObj);
        }

        if(callBackOption.code == -4){
            console.log('创建事件-失败',callBackOption);
        }

    }
});

• 获取创建的日历事件提醒

xweCalendar.getCalendarEvent(option)

option结构说明

callback返回参数说明

callbackOption结构说明

data数组对象（Array\<Object>）结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xweCalendar.getCalendarEvent({
    startYear:2023,
    startMonth:8,
    startDay:17,
    startHour:11,
    startMinute:5,
    endYear:2023,
    endMonth:8,
    endDay:17,
    endHour:11,
    endMinute:10,
    callback:(callBackOption:Object) => {
        if(callBackOption.code == 5){
            let dataObj:Object = callBackOption.data ? JSON.parse(callBackOption.data) : {};

            console.log('获取事件数据-成功',callBackOption,dataObj);
        }

        if(callBackOption.code == -5){
            console.log('获取事件数据-失败',callBackOption);
        }

    }
});

• 删除日历事件提醒

xweCalendar.removeCalendarEvent(option)

option结构说明

callback返回参数说明

callbackOption结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xweCalendar.removeCalendarEvent({
    eventIdentifier:'738691FC-9785-40F2-BCF8-38E236B09280:52732A2F-403B-4E50-9D9A-F7AF4B85CFE1',
    callback:(callBackOption:Object) => {
        if(callBackOption.code == 6){
            console.log('删除事件-成功',callBackOption);
        }

        if(callBackOption.code == -6){
            console.log('删除事件-失败',callBackOption);
        }

    }
});

code状态码说明