1 files changed, 93 insertions, 0 deletions
diff --git a/lib/public/IAddressBook.php b/lib/public/IAddressBook.php
new file mode 100644
index 00000000000..63e7e061448
--- /dev/null
+++ b/lib/public/IAddressBook.php
@@ -0,0 +1,93 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * IAddressBook interface
+ */
+
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal ownCloud classes
+namespace OCP {
+	/**
+	 * Interface IAddressBook
+	 *
+	 * @package OCP
+	 * @since 5.0.0
+	 */
+	interface IAddressBook {
+
+		/**
+		 * @return string defining the technical unique key
+		 * @since 5.0.0
+		 */
+		public function getKey();
+
+		/**
+		 * In comparison to getKey() this function returns a human readable (maybe translated) name
+		 * @return mixed
+		 * @since 5.0.0
+		 */
+		public function getDisplayName();
+
+		/**
+		 * @param string $pattern which should match within the $searchProperties
+		 * @param array $searchProperties defines the properties within the query pattern should match
+		 * @param array $options - for future use. One should always have options!
+		 * @return array an array of contacts which are arrays of key-value-pairs
+		 * @since 5.0.0
+		 */
+		public function search($pattern, $searchProperties, $options);
+		//	// dummy results
+		//	return array(
+		//		array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'),
+		//		array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')),
+		//	);
+
+		/**
+		 * @param array $properties this array if key-value-pairs defines a contact
+		 * @return array an array representing the contact just created or updated
+		 * @since 5.0.0
+		 */
+		public function createOrUpdate($properties);
+		//	// dummy
+		//	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
+		//		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
+		//		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
+		//	);
+
+		/**
+		 * @return mixed
+		 * @since 5.0.0
+		 */
+		public function getPermissions();
+
+		/**
+		 * @param object $id the unique identifier to a contact
+		 * @return bool successful or not
+		 * @since 5.0.0
+		 */
+		public function delete($id);
+	}
+}