IAddressBook¶
-
interface
OCP\
IAddressBook
¶ - Interface IAddressBook
Source: lib/public/IAddressBook.php#45
Methods¶
-
public
OCP\IAddressBook::
getKey
()¶ Source: lib/public/IAddressBook.php#51 Returns: string defining the technical unique key Since: 5.0.0
-
public
OCP\IAddressBook::
getUri
()¶ Source: lib/public/IAddressBook.php#58 Returns: string defining the unique uri Since: 16.0.0 Returns: string defining the unique uri
-
public
OCP\IAddressBook::
getDisplayName
()¶ - In comparison to getKey() this function returns a human readable (maybe translated) name
Source: lib/public/IAddressBook.php#65 Returns: mixed Since: 5.0.0
-
public
OCP\IAddressBook::
search
($pattern, $searchProperties, $options)¶ Source: Parameters: - $pattern (string) which should match within the $searchProperties
- $searchProperties (array) defines the properties within the query pattern should match
- $options (array) Options to define the output format and search behavior
- ‘types’ boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array example: [‘id’ => 5, ‘FN’ => ‘Thomas Tanghus’, ‘EMAIL’ => [‘type => ‘HOME’, ‘value’ => 'g@h.i‘]]
- ‘escape_like_param’ - If set to false wildcards _ and % are not escaped
- ‘limit’ - Set a numeric limit for the search results
- ‘offset’ - Set the offset for the limited search results
Returns: - array an array of contacts which are arrays of key-value-pairs
example result: [
]
Since: 5.0.0
-
public
OCP\IAddressBook::
createOrUpdate
($properties)¶ Source: Parameters: - $properties (array) this array if key-value-pairs defines a contact
Returns: array an array representing the contact just created or updated
Since: 5.0.0
-
public
OCP\IAddressBook::
getPermissions
()¶ Source: lib/public/IAddressBook.php#102 Returns: mixed Since: 5.0.0
-
public
OCP\IAddressBook::
delete
($id)¶ Source: Parameters: - $id (object) the unique identifier to a contact
Returns: bool successful or not
Since: 5.0.0
- Returns true if this address-book is not owned by the current user,but shared with them.
Source: lib/public/IAddressBook.php#118 Returns: bool Since: 20.0.0
-
public
OCP\IAddressBook::
isSystemAddressBook
()¶ Source: lib/public/IAddressBook.php#124 Returns: bool Since: 20.0.0