blob: 6542db2365020b104b926e722dfc39293786790b (
plain)
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
|
<?php
declare(strict_types=1);
/**
*
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\DAV\CardDAV\Integration;
/**
* @since 19.0.0
*/
interface IAddressBookProvider {
/**
* Provides the appId of the plugin
*
* @since 19.0.0
* @return string AppId
*/
public function getAppId(): string;
/**
* Fetches all address books for a given principal uri
*
* @since 19.0.0
* @param string $principalUri E.g. principals/users/user1
* @return ExternalAddressBook[] Array of all address books
*/
public function fetchAllForAddressBookHome(string $principalUri): array;
/**
* Checks whether plugin has an address book for a given principalUri and URI
*
* @since 19.0.0
* @param string $principalUri E.g. principals/users/user1
* @param string $uri E.g. personal
* @return bool True if address book for principalUri and URI exists, false otherwise
*/
public function hasAddressBookInAddressBookHome(string $principalUri, string $uri): bool;
/**
* Fetches an address book for a given principalUri and URI
* Returns null if address book does not exist
*
* @param string $principalUri E.g. principals/users/user1
* @param string $uri E.g. personal
*
* @return ExternalAddressBook|null address book if it exists, null otherwise
*@since 19.0.0
*/
public function getAddressBookInAddressBookHome(string $principalUri, string $uri): ?ExternalAddressBook;
}
|
