diff options
Diffstat (limited to 'lib/public/iaddressbook.php')
| -rw-r--r-- | lib/public/iaddressbook.php | 12 |
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); } |