1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Calendar;
use DateTimeInterface;
use OCP\IUser;
/**
* This class provides access to the Nextcloud CalDAV backend.
* Use this class exclusively if you want to access calendars.
*
* Events/Journals/Todos in general will be expressed as an array of key-value-pairs.
* The keys will match the property names defined in https://tools.ietf.org/html/rfc5545
*
* [
* 'id' => 123,
* 'type' => 'VEVENT',
* 'calendar-key' => 42,
* 'objects' => [
* [
* 'SUMMARY' => ['FooBar', []],
* 'DTSTART' => ['20171001T123456', ['TZID' => 'EUROPE/BERLIN']],
* 'DURATION' => ['P1D', []],
* 'ATTENDEE' => [
* ['mailto:bla@blub.com', ['CN' => 'Mr. Bla Blub']]
* ],
* 'VALARM' => [
* [
* 'TRIGGER' => ['19980101T050000Z', ['VALUE' => DATE-TIME]]
* ]
* ]
* ],
* ]
* ]
*
* @since 13.0.0
*/
interface IManager {
/**
* This function is used to search and find objects within the user's calendars.
* In case $pattern is empty all events/journals/todos will be returned.
*
* @param string $pattern which should match within the $searchProperties
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - optional parameters:
* ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
* @param integer|null $limit - limit number of search results
* @param integer|null $offset - offset for paging of search results
* @return array an array of events/journals/todos which are arrays of arrays of key-value-pairs
* @since 13.0.0
* @deprecated 23.0.0 use \OCP\Calendar\IManager::searchForPrincipal
*/
public function search($pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null);
/**
* Check if calendars are available
*
* @return bool true if enabled, false if not
* @since 13.0.0
* @deprecated 23.0.0
*/
public function isEnabled();
/**
* Registers a calendar
*
* @param ICalendar $calendar
* @return void
* @since 13.0.0
* @deprecated 23.0.0 use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerCalendarProvider
*/
public function registerCalendar(ICalendar $calendar);
/**
* Unregisters a calendar
*
* @param ICalendar $calendar
* @return void
* @since 13.0.0
* @deprecated 23.0.0
*/
public function unregisterCalendar(ICalendar $calendar);
/**
* In order to improve lazy loading a closure can be registered which will be called in case
* calendars are actually requested
*
* @param \Closure $callable
* @return void
* @since 13.0.0
* @deprecated 23.0.0 use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerCalendarProvider
*/
public function register(\Closure $callable);
/**
* @return ICalendar[]
* @since 13.0.0
* @deprecated 23.0.0 use \OCP\Calendar\IManager::getCalendarsForPrincipal
*/
public function getCalendars();
/**
* removes all registered calendar instances
*
* @return void
* @since 13.0.0
* @deprecated 23.0.0
*/
public function clear();
/**
* @param string $principalUri URI of the principal
* @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty
*
* @return ICalendar[]
* @since 23.0.0
*/
public function getCalendarsForPrincipal(string $principalUri, array $calendarUris = []): array;
/**
* Query a principals calendar(s)
*
* @param ICalendarQuery $query
* @return array[]
* @since 23.0.0
*/
public function searchForPrincipal(ICalendarQuery $query): array;
/**
* Build a new query for searchForPrincipal
*
* @return ICalendarQuery
* @since 23.0.0
*/
public function newQuery(string $principalUri) : ICalendarQuery;
/**
* Handle a iMip REQUEST message
*
* @since 31.0.0
*/
public function handleIMipRequest(string $principalUri, string $sender, string $recipient, string $calendarData): bool;
/**
* Handle a iMip REPLY message
*
* @since 25.0.0
*/
public function handleIMipReply(string $principalUri, string $sender, string $recipient, string $calendarData): bool;
/**
* Handle a iMip CANCEL message
*
* @since 25.0.0
*/
public function handleIMipCancel(string $principalUri, string $sender, ?string $replyTo, string $recipient, string $calendarData): bool;
/**
* Create a new event builder instance. Please have a look at its documentation and the
* \OCP\Calendar\ICreateFromString interface on how to use it.
*
* @since 31.0.0
*/
public function createEventBuilder(): ICalendarEventBuilder;
/**
* Check the availability of the given organizer and attendees in the given time range.
*
* @since 31.0.0
*
* @param IUser $organizer The organizing user from whose perspective to do the availability check.
* @param string[] $attendees Email addresses of attendees to check for (with or without a "mailto:" prefix). Only users on this instance can be checked. The rest will be silently ignored.
* @return IAvailabilityResult[] Availabilities of the organizer and all attendees which are also users on this instance. As such, the array might not contain an entry for each given attendee.
*/
public function checkAvailability(
DateTimeInterface $start,
DateTimeInterface $end,
IUser $organizer,
array $attendees,
): array;
}
|
