Nextcloud PHP API (stable19)

ICalendar

Interface ICalendar

Tags
since
13.0.0

Table of Contents

getDisplayColor()  : null|string
Calendar color
getDisplayName()  : null|string
In comparison to getKey() this function returns a human readable (maybe translated) name
getKey()  : string
getPermissions()  : int
search()  : array

Methods

getDisplayColor()

Calendar color

public getDisplayColor() : null|string
Tags
since
13.0.0
Return values
null|string

getDisplayName()

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

public getDisplayName() : null|string
Tags
since
13.0.0
Return values
null|string

getKey()

public getKey() : string
Tags
since
13.0.0
Return values
string

defining the technical unique key

getPermissions()

public getPermissions() : int
Tags
since
13.0.0
Return values
int

build up using \OCP\Constants

public search(string $pattern[, array $searchProperties = [] ][, array $options = [] ][, int|null $limit = null ][, int|null $offset = null ]) : array
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 = null
  • limit number of search results
$offset : int|null = null
  • offset for paging of search results
Tags
since
13.0.0
Return values
array

an array of events/journals/todos which are arrays of key-value-pairs

Search results