ICalendar¶

interface OCP\Calendar\ICalendar¶

Interface ICalendar

Source:	lib/public/Calendar/ICalendar.php#32

Methods¶

public OCP\Calendar\ICalendar::getKey()¶

Source:	lib/public/Calendar/ICalendar.php#38
Returns:	string defining the technical unique key
Since:	13.0.0

public OCP\Calendar\ICalendar::getDisplayName()¶

In comparison to getKey() this function returns a human readable (maybe translated) name

Source:	lib/public/Calendar/ICalendar.php#45
Returns:	null \| string
Since:	13.0.0

public OCP\Calendar\ICalendar::getDisplayColor()¶

Calendar color

Source:	lib/public/Calendar/ICalendar.php#52
Returns:	null \| string
Since:	13.0.0

public OCP\Calendar\ICalendar::search($pattern, $searchProperties=[], $options=[], $limit=null, $offset=null)¶

Source:	lib/public/Calendar/ICalendar.php#64
Parameters:	$pattern (string) which should match within the $searchProperties $searchProperties (array) defines the properties within the query pattern should match $options (array) - optional parameters: [‘timerange’ => [‘start’ => new DateTime(...), ‘end’ => new DateTime(...)]] * $limit (int \| null) - limit number of search results * $offset (int \| null) - offset for paging of search results
Returns:	array an array of events/journals/todos which are arrays of key-value-pairs
Since:	13.0.0

public OCP\Calendar\ICalendar::getPermissions()¶

Source:	lib/public/Calendar/ICalendar.php#70
Returns:	int build up using \OCP\Constants
Since:	13.0.0