Flutter日程管理插件remind_caldav_client的使用

CalDAV Client

一个用于 Dart 的 CalDAV 客户端。它允许你轻松快速地向服务器发送 CalDAV 请求。

教程

设置

要使用 CalDAV 客户端，你需要创建一个 CalDavClient 实例，并传入将要发送请求的 URL。

var client = CalDavClient(
  baseUrl: "http://example.com/caldav.php/user/calendar/", // 请替换为你的实际URL
);

初始同步

首先，你可能希望进行初始同步，这将返回每个日历集合的 path、displayname 和 ctag。 这个 ctag 类似于更改 ID。每当 ctag 发生变化时，你知道日历中某些东西也发生了变化。

var response = await client.initialSync(path);

返回属性：getctag 和 displayname。

获取对象

如果你想要获取日历数据，需要使用 getObjects 方法。通过此方法，你可以获得 calendar-data，此外还有 path 和 etag。 这些数据是由每个 .ics 文件（即每个日历对象）获得的。该方法必须接收作为参数的日历集合路径。 当日历对象发生变化时，etag 也会改变。

var response = await client.getObjects(collectionPath);

返回属性：getetag 和 calendar-data。

在时间范围内获取对象

要获取某个时间段内的对象，可以使用 getObjectsInTimeRange 方法。通过此方法，你可以获得 calendar-data，此外还有 path 和 etag。

var now = DateTime.now();
var end = DateTime.utc(2021, 11, 9);
var response = await client.getObjectsInTimeRange(collectionPath, now, end);

返回属性：getetag 和 calendar-data。

获取更改

你必须首先执行另一个初始同步以查看 ctag 是否发生变化。如果发生变化，则可以更具体地检查每个对象以查看哪些对象已更改。为此，你必须使用 getChanges 方法，它会返回每个 etag。请记住，每个 etag 都会在对象发生变化时改变。除了 etag 外，你还应该检查是否存在任何新的或缺少的 URL。

var response = await client.getChanges(collectionPath);

返回属性：getetag。

下载 .ics 文件

如果你想下载每个日历对象的 .ics 文件，必须使用 downloadIcs 方法。第一个参数是要下载的文件路径，第二个参数是你想保存它的目录路径。

var response = await client.downloadIcs(objectPath, pathToSave);

多获取

频繁地使用 getObject 查询可能会导致带宽消耗较高。如果我们用 downloadIcs 查询数据，对每个更改的对象进行查询可能会很麻烦。为了解决这个问题，我们可以使用 multiget 方法。multiget 允许我们查询多个日历对象的数据，不一定是所有对象。 它接受作为第一个参数的日历集合路径和作为第二个参数的要查询的对象列表。

var files = ['object1.ics', 'object2.ics'];

var response = await client.multiget(collectionPath, files);

返回属性：getetag 和 calendar-data。

更新日历

如果你想更新一个对象，只需使用 updateCal 方法即可。它接收作为参数的对象路径、etag 和将要替换它的日历对象。日历必须遵循 iCalendar 规范。

var response = await client.updateCal(objectPath, etag, icalendar);

几点注意事项：

• 你不能改变原始对象的 UID。
• 每个对象只能包含一个事件或任务。
• 你不能将 VEVENT 改变为 VTODO。

创建日历

创建一个日历对象非常简单，只需要注意使用的路径不能被其他对象使用。

var response = await client.createCal(newObjectPath, icalendar);

删除日历

删除一个日历对象可能是最简单的事情。只需确保第二个参数的 etag 与要删除的对象的 etag 匹配。要删除的对象位于第一个参数的路径中。

var response = await client.deleteCal(objectPath, etag);

多状态

使用 CalDAV 进行查询的结果是通过多状态返回的。多状态包含了不同元素（无论是日历还是对象）的信息，以及返回的状态。其结构如下所示：

.
+-- Multistatus  
    +-- Response (list)
        +-- href
        +-- Propstat
            +-- prop (map)
            +-- status