@ capgo/ 电容- calendar

从您的 Capacitor app 创建、 读取、 更新和删除日历事件, 或在 iOS 和 Android 上打开本地事件编辑器 。 在iOS上,您也可以完全访问提醒.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-calendar 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-calendar到我的 Capacitor app上,并把它连接起来。" 代理设置指南 • 妇女 主机磁共振

主要特点

• 原生编辑器数字 : createEventWithPrompt() 财务报告和审定财务报表 modifyEventWithPrompt() 打开系统事件编辑器. deleteEventWithPrompt() 请求确认, 并在 Android 上设置插件对话框 .
• 事件 API数字 : createEvent(), (中文(简体) ), modifyEvent(), (中文(简体) ), deleteEvent(), (中文(简体) ), deleteEventsById() 财务报告和审定财务报表 listEventsInRange()。 。 。 .
• 日历数字 : listCalendars(), (中文(简体) ), getDefaultCalendar(), (中文(简体) ), createCalendar(), (中文(简体) ), modifyCalendar() 财务报告和审定财务报表 deleteCalendar()。 。 。 .
• IOS 上的提醒数字 : createReminder(), (中文(简体) ), modifyReminder(), (中文(简体) ), getRemindersFromLists() 还有更多.
• 优劣权限:只写和完整的日历访问,在Android上只读访问,外加提醒访问.
• 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. iOS 使用 EventKit, Android 使用 CalendarContract。提醒仅仅是iOS。 在网上不可用.

Capacitor apps的本地日历和提醒访问. 使用它来请求日历权限,创建和编辑事件,打开系统日历UI,列出日历和事件,并在iOS上管理提醒.

此软件包是一个 Capgo 维护的日历插件版本, 最初由 Capgo 创建 埃桑·巴罗尼,并移植到 Capgo Capacitor 插件模板和 Capacitor 8.

目录

• 安装
• 演示
• 设置
• 快速启动
• 常见食谱
• 平台支持
• 兼容性
• 文档
• 更改日志
• API 密码
• 许可证和归属

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-calendar` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-calendar
npx cap sync

演示

iOS系统	机器人

设置

此插件使用本地日历 API,因此在运行时请求访问前,每个平台都需要权限配置.

官方平台参考文献:

• iOS: 迁移到最新的日历访问级别
• Android:日历提供者用户权限

iOS系统

添加您的应用程序需要的使用描述 ios/App/App/Info.plist. iOS 17和较新的区分只写和全日历访问.

<key>NSCalendarsUsageDescription</key>
<string>This app needs calendar access.</string>
<key>NSCalendarsWriteOnlyAccessUsageDescription</key>
<string>This app needs permission to add calendar events.</string>
<key>NSCalendarsFullAccessUsageDescription</key>
<string>This app needs permission to read and manage calendar events.</string>
<key>NSRemindersUsageDescription</key>
<string>This app needs reminders access.</string>
<key>NSRemindersFullAccessUsageDescription</key>
<string>This app needs permission to read and manage reminders.</string>

只包含匹配您的应用调用 API 的密钥 。 例如,一个只创建有只写访问的日历事件的应用程序不需要提醒键.

机器人

添加您的应用程序需要的权限 android/app/src/main/AndroidManifest.xml数字 :

<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.WRITE_CALENDAR" />

然后在读取或写入日历数据前在运行时间请求匹配权限.

快速启动

import { CapacitorCalendar } from '@capgo/capacitor-calendar';

const permission = await CapacitorCalendar.requestFullCalendarAccess();

if (permission.result !== 'granted') {
  throw new Error('Calendar permission was not granted');
}

const startDate = Date.now() + 60 * 60 * 1000;
const endDate = startDate + 60 * 60 * 1000;

const { id } = await CapacitorCalendar.createEvent({
  title: 'Product review',
  location: 'Capgo',
  startDate,
  endDate,
  description: 'Created with @capgo/capacitor-calendar',
});

console.log('Created event', id);

日期为Unix时间戳以毫秒为单位.

常见食谱

打开本地事件编辑器

await CapacitorCalendar.createEventWithPrompt({
  title: 'Planning session',
  location: 'Office',
  startDate: Date.now() + 24 * 60 * 60 * 1000,
  endDate: Date.now() + 25 * 60 * 60 * 1000,
});

关于Android, createEventWithPrompt 财务报告和审定财务报表 modifyEventWithPrompt 总是返回 null。如果需要找到创建的事件 ID,则列出事件后的情况.

列出即将举行的活动

const now = Date.now();
const oneWeekFromNow = now + 7 * 24 * 60 * 60 * 1000;

const { result: events } = await CapacitorCalendar.listEventsInRange({
  from: now,
  to: oneWeekFromNow,
});

选择日历

const { result: calendars } = await CapacitorCalendar.listCalendars();
const { result: defaultCalendar } = await CapacitorCalendar.getDefaultCalendar();

const calendarId = defaultCalendar?.id ?? calendars[0]?.id;

selectCalendarsWithPrompt 可以在iOS上显示系统日历选择器.

创建 iOS 提醒

const permission = await CapacitorCalendar.requestFullRemindersAccess();

if (permission.result === 'granted') {
  await CapacitorCalendar.createReminder({
    title: 'Send launch notes',
    dueDate: Date.now() + 2 * 24 * 60 * 60 * 1000,
    notes: 'Created with @capgo/capacitor-calendar',
  });
}

提醒 API 仅为 iOS .

平台支持

网络执行仅作为Capacitor stub存在,并拒绝只使用本土的呼叫.

兼容性

文档

生成的API参考如下. 源类型定义在 斜弧/定义.ts,软件包主页是 capgo.app/docs/插件/日历。 。 。 .

关于与旧代码的兼容性, requestPermission(...) 财务报告和审定财务报表 requestAllPermissions() 现仍可提供。 新应用程序应该更喜欢 requestWriteOnlyCalendarAccess(), (中文(简体) ), requestReadOnlyCalendarAccess(), (中文(简体) ), requestFullCalendarAccess(),以及 requestFullRemindersAccess()。 。 。 .

更改日志

见 变动情况 用于发行笔记.

许可证和归属

这个软件包在MPL-2.0下发布. 原画 @ebarooni/capacitor-calendar ehsan Barooni在麻省理工学院下发布了项目;见 第三次议会 NoTICES.md 用于归属.

API 密码

• checkPermission(...)
• checkAllPermissions()
• requestPermission(...)
• requestAllPermissions()
• requestWriteOnlyCalendarAccess()
• requestReadOnlyCalendarAccess()
• requestFullCalendarAccess()
• requestFullRemindersAccess()
• createEventWithPrompt(...)
• modifyEventWithPrompt(...)
• createEvent(...)
• modifyEvent(...)
• deleteEventsById(...)
• deleteEvent(...)
• deleteEventWithPrompt(...)
• listEventsInRange(...)
• commit()
• selectCalendarsWithPrompt(...)
• fetchAllCalendarSources()
• listCalendars()
• getDefaultCalendar()
• openCalendar(...)
• createCalendar(...)
• deleteCalendar(...)
• modifyCalendar(...)
• fetchAllRemindersSources()
• openReminders()
• getDefaultRemindersList()
• getRemindersLists()
• createReminder(...)
• deleteRemindersById(...)
• deleteReminder(...)
• modifyReminder(...)
• getReminderById(...)
• getRemindersFromLists(...)
• deleteReminderWithPrompt(...)
• 接口
• 类型异名
• 数字

检查许可(...)

checkPermission(options: { scope: CalendarPermissionScope; }) => Promise<{ result: PermissionState; }>

为给定范围获取当前权限状态.

回返情况: Promise<{ result: PermissionState; }>

自: 0.1.0 (中文(简体) )

检查所有许可( A)

checkAllPermissions() => Promise<{ result: CheckAllPermissionsResult; }>

获取所有权限的当前状态 .

回返情况: Promise<{ result: CheckAllPermissionsResult; }>

自: 0.1.0 (中文(简体) )

请求许可(...)

requestPermission(options: { scope: CalendarPermissionScope; }) => Promise<{ result: PermissionState; }>

请求准许某一范围.

回返情况: Promise<{ result: PermissionState; }>

自: 0.1.0 (中文(简体) )

请求全部许可( )

requestAllPermissions() => Promise<{ result: RequestAllPermissionsResult; }>

请求允许所有日历和提醒权限 .

回返情况: Promise<{ result: CheckAllPermissionsResult; }>

自: 0.1.0 (中文(简体) )

请求仅写 Calendar 访问 ()

requestWriteOnlyCalendarAccess() => Promise<{ result: PermissionState; }>

请求写入日历 .

回返情况: Promise<{ result: PermissionState; }>

自: 5.4.0 (单位:千美元)

请求只读 CalendarAccess ()

requestReadOnlyCalendarAccess() => Promise<{ result: PermissionState; }>

请查看日历 .

回返情况: Promise<{ result: PermissionState; }>

自: 5.4.0 (单位:千美元)

请求FullCalendar Access ()

requestFullCalendarAccess() => Promise<{ result: PermissionState; }>

请求读取和写入日历.

回返情况: Promise<{ result: PermissionState; }>

自: 5.4.0 (单位:千美元)

请求FulllReminders Access( )

requestFullRemindersAccess() => Promise<{ result: PermissionState; }>

请求可读取和写入提醒.

回返情况: Promise<{ result: PermissionState; }>

自: 5.4.0 (单位:千美元)

创建 Event With Prompt (...)

createEventWithPrompt(options?: CreateEventWithPromptOptions | undefined) => Promise<{ id: string | null; }>

打开系统日历界面创建新事件. 在Android上,它总是返回 null; 获取事件以找到新创建的事件 ID.

回返情况: Promise<{ id: string | null; }>

自: 0.1.0 (中文(简体) )

修改 Event With Prompt (...)

modifyEventWithPrompt(options: ModifyEventWithPromptOptions) => Promise<{ result: EventEditAction | null; }>

打开系统日历界面来修改一个事件. 在Android上,它总是返回 null。 。 。 .

回返情况: Promise<{ result: EventEditAction | null; }>

自: 6.6.0 (简体中文)

创建 Event (...)

createEvent(options: CreateEventOptions) => Promise<{ id: string; }>

在日历中创建事件.

回返情况: Promise<{ id: string; }>

自: 0.4.0 (中文(简体) )

修改 Event (...)

modifyEvent(options: ModifyEventOptions) => Promise<void>

修改一个事件.

自: 6.6.0 (简体中文)

删除 EventsById(...)

deleteEventsById(options: DeleteEventsByIdOptions) => Promise<{ result: DeleteEventsByIdResult; }>

删除多个事件.

回返情况: Promise<{ result: DeleteEventsByIdResult; }>

自: 0.11.0 (中文(简体) )

删除 Event (...)

deleteEvent(options: DeleteEventOptions) => Promise<void>

删除事件.

自: 7.1.0 (中文(简体) )

删除 Event With Prompt (...)

deleteEventWithPrompt(options: DeleteEventWithPromptOptions) => Promise<{ deleted: boolean; }>

打开对话框删除事件.

回返情况: Promise<{ deleted: boolean; }>

自: 7.1.0 (中文(简体) )

列表 Events In Range (...)

listEventsInRange(options: ListEventsInRangeOptions) => Promise<{ result: CalendarEvent[]; }>

在一个日期范围内检索事件.

回返情况: Promise<{ result: CalendarEvent[]; }>

自: 0.10.0 (中文(简体) )

实施( )

commit() => Promise<void>

保存等待的 iOS 日历更改 .

自: 7.1.0 (中文(简体) )

选择 Calendars With Prompt (...)

selectCalendarsWithPrompt(options?: SelectCalendarsWithPromptOptions | undefined) => Promise<{ result: Calendar[]; }>

打开一个系统接口来选择一个或多个日历.

回返情况: Promise<{ result: Calendar[]; }>

自: 0.2.0 (中文(简体) )

获取 AllCalendar 源代码 ()

fetchAllCalendarSources() => Promise<{ result: CalendarSource[]; }>

获取日历源列表 .

回返情况: Promise<{ result: CalendarSource[]; }>

自: 6.6.0 (简体中文)

列表计数器( )

listCalendars() => Promise<{ result: Calendar[]; }>

检索所有可用的日历 .

回返情况: Promise<{ result: Calendar[]; }>

自: 7.1.0 (中文(简体) )

获得默认日历( C)

getDefaultCalendar() => Promise<{ result: Calendar | null; }>

获取默认日历 .

回返情况: Promise<{ result: Calendar | null; }>

自: 0.3.0 (中文(简体) )

打开日历(...)

openCalendar(options?: OpenCalendarOptions | undefined) => Promise<void>

打开日历应用程序.

自: 7.1.0 (中文(简体) )

创建 Calendar (...)

createCalendar(options: CreateCalendarOptions) => Promise<{ id: string; }>

创建日历.

回返情况: Promise<{ id: string; }>

自: 5.2.0 (中文(简体) )

删除日历(...)

deleteCalendar(options: DeleteCalendarOptions) => Promise<void>

用 ID 删除日历.

自: 5.2.0 (中文(简体) )

修改日历(...)

modifyCalendar(options: ModifyCalendarOptions) => Promise<void>

修改日历 .

自: 7.2.0 联合国

获取 AllReminders 来源( )

fetchAllRemindersSources() => Promise<{ result: CalendarSource[]; }>

获取提醒来源列表 .

回返情况: Promise<{ result: CalendarSource[]; }>

自: 6.6.0 (简体中文)

打开复刻器( )

openReminders() => Promise<void>

打开提醒应用程序.

自: 7.1.0 (中文(简体) )

获取默认Reminders列表 ()

getDefaultRemindersList() => Promise<{ result: RemindersList | null; }>

获取默认提醒列表.

回返情况: Promise<{ result: Calendar | null; }>

自: 7.1.0 (中文(简体) )

获取Reminders 列表 ()

getRemindersLists() => Promise<{ result: RemindersList[]; }>

获取所有可用的提醒列表.

回返情况: Promise<{ result: Calendar[]; }>

自: 7.1.0 (中文(简体) )

创建 Reminder (...)

createReminder(options: CreateReminderOptions) => Promise<{ id: string; }>

创建提醒.

回返情况: Promise<{ id: string; }>

自: 0.5.0 (单位:千美元)

删除RemindersById(...)

deleteRemindersById(options: DeleteRemindersByIdOptions) => Promise<{ result: DeleteRemindersByIdResult; }>

删除多个提醒.

回返情况: Promise<{ result: DeleteRemindersByIdResult; }>

自: 5.3.0 (中文(简体) )

删除Reminder(...)

deleteReminder(options: DeleteReminderOptions) => Promise<void>

删除提醒.

自: 7.1.0 (中文(简体) )

修改Reminder(...)

modifyReminder(options: ModifyReminderOptions) => Promise<void>

修改一个教诲.

自: 6.7.0 (简体中文)

获取ReminderById(...)

getReminderById(options: GetReminderByIdOptions) => Promise<{ result: Reminder | null; }>

用身份证获取提醒 .

回返情况: Promise<{ result: Reminder | null; }>

自: 7.1.0 (中文(简体) )

获取 Reminders fromLists (...)

getRemindersFromLists(options: GetRemindersFromListsOptions) => Promise<{ result: Reminder[]; }>

从多个列表获取提醒 .

回返情况: Promise<{ result: Reminder[]; }>

自: 5.3.0 (中文(简体) )

删除 Reminder With Prompt (...)

deleteReminderWithPrompt(options: DeleteReminderWithPromptOptions) => Promise<{ deleted: boolean; }>

打开对话框删除提醒.

回返情况: Promise<{ deleted: boolean; }>

自: 7.2.0 联合国

接口

创建带有Prompt 选项的事件

重犯规则

修改“ 快速” 选项

创建事件选项

事件嘉宾

修改事件选项

删除事件ById结果

删除事件ById 选项

删除选项

删除带有Prompt选项的Event

日历事件

列出在远程选项中的事件

日历

日历来源

选择带有Prompt选项的算法

OpenCalendar 选项

创建算法选项

删除计时器选项

修改日历选项

创建重命名选项