1
0

IAddressBook.php 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Bart Visscher <bartv@thisnet.nl>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  7. * @author Robin McCorkell <robin@mccorkell.me.uk>
  8. * @author Thomas Müller <thomas.mueller@tmit.eu>
  9. *
  10. * @license AGPL-3.0
  11. *
  12. * This code is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License, version 3,
  14. * as published by the Free Software Foundation.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License, version 3,
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>
  23. *
  24. */
  25. /**
  26. * Public interface of ownCloud for apps to use.
  27. * IAddressBook interface
  28. */
  29. // use OCP namespace for all classes that are considered public.
  30. // This means that they should be used by apps instead of the internal ownCloud classes
  31. namespace OCP {
  32. /**
  33. * Interface IAddressBook
  34. *
  35. * @package OCP
  36. * @since 5.0.0
  37. */
  38. interface IAddressBook {
  39. /**
  40. * @return string defining the technical unique key
  41. * @since 5.0.0
  42. */
  43. public function getKey();
  44. /**
  45. * In comparison to getKey() this function returns a human readable (maybe translated) name
  46. * @return mixed
  47. * @since 5.0.0
  48. */
  49. public function getDisplayName();
  50. /**
  51. * @param string $pattern which should match within the $searchProperties
  52. * @param array $searchProperties defines the properties within the query pattern should match
  53. * @param array $options - for future use. One should always have options!
  54. * @return array an array of contacts which are arrays of key-value-pairs
  55. * @since 5.0.0
  56. */
  57. public function search($pattern, $searchProperties, $options);
  58. // // dummy results
  59. // return array(
  60. // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'),
  61. // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')),
  62. // );
  63. /**
  64. * @param array $properties this array if key-value-pairs defines a contact
  65. * @return array an array representing the contact just created or updated
  66. * @since 5.0.0
  67. */
  68. public function createOrUpdate($properties);
  69. // // dummy
  70. // return array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
  71. // 'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
  72. // 'ADR' => ';;123 Main Street;Any Town;CA;91921-1234'
  73. // );
  74. /**
  75. * @return mixed
  76. * @since 5.0.0
  77. */
  78. public function getPermissions();
  79. /**
  80. * @param object $id the unique identifier to a contact
  81. * @return bool successful or not
  82. * @since 5.0.0
  83. */
  84. public function delete($id);
  85. }
  86. }