[contacts_api] update documentation

remotes/origin/stable5
Thomas Mueller 12 years ago
parent 35e55214e2
commit 889e55fdac
  1. 16
      lib/public/contacts.php

@ -41,10 +41,10 @@ namespace OC {
public function getDisplayName(); public function getDisplayName();
/** /**
* @param $pattern * @param string $pattern which should match within the $searchProperties
* @param $searchProperties * @param array $searchProperties defines the properties within the query pattern should match
* @param $options * @param array $options - for future use. One should always have options!
* @return mixed * @return array of contacts which are arrays of key-value-pairs
*/ */
public function search($pattern, $searchProperties, $options); public function search($pattern, $searchProperties, $options);
// // dummy results // // dummy results
@ -54,8 +54,8 @@ namespace OC {
// ); // );
/** /**
* @param $properties * @param array $properties this array if key-value-pairs defines a contact
* @return mixed * @return array representing the contact just created or updated
*/ */
public function createOrUpdate($properties); public function createOrUpdate($properties);
// // dummy // // dummy
@ -70,8 +70,8 @@ namespace OC {
public function getPermissions(); public function getPermissions();
/** /**
* @param $id * @param object $id the unique identifier to a contact
* @return mixed * @return bool successful or not
*/ */
public function delete($id); public function delete($id);
} }

Loading…
Cancel
Save