summaryrefslogtreecommitdiffstats
path: root/lib/public/iaddressbook.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/iaddressbook.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/iaddressbook.php')
-rw-r--r--lib/public/iaddressbook.php12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/public/iaddressbook.php b/lib/public/iaddressbook.php
index 978becf16d9..f3f60ab22d7 100644
--- a/lib/public/iaddressbook.php
+++ b/lib/public/iaddressbook.php
@@ -30,16 +30,24 @@
// 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();
@@ -48,6 +56,7 @@ namespace OCP {
* @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
@@ -59,6 +68,7 @@ namespace OCP {
/**
* @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
@@ -69,12 +79,14 @@ namespace OCP {
/**
* @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);
}