IContactsStore.php 753 B

1234567891011121314151617181920212223242526272829
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-License-Identifier: AGPL-3.0-or-later
  5. */
  6. namespace OCP\Contacts\ContactsMenu;
  7. use OCP\IUser;
  8. /**
  9. * @since 13.0.0
  10. */
  11. interface IContactsStore {
  12. /**
  13. * @param IUser $user
  14. * @param string|null $filter
  15. * @param int|null $limit added 19.0.2
  16. * @param int|null $offset added 19.0.2
  17. * @return IEntry[]
  18. * @since 13.0.0
  19. */
  20. public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array;
  21. /**
  22. * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith)
  23. * @since 13.0.0
  24. */
  25. public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry;
  26. }