aboutsummaryrefslogtreecommitdiffstats
path: root/apps/dav/lib/CardDAV/Integration/IAddressBookProvider.php
blob: 1299d935c5706052373ffa1a8e1197f7e9644147 (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
<?php

declare(strict_types=1);

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;

}