ICalendar
in
Interface ICalendar
Tags
Table of Contents
Methods
- 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
- getUri() : string
- In comparison to getKey() this function returns a unique uri within the scope of the principal
- isDeleted() : bool
- Whether the calendar is deleted
- search() : array<string|int, mixed>
Methods
getDisplayColor()
Calendar color
public
getDisplayColor() : null|string
Tags
Return values
null|stringgetDisplayName()
In comparison to getKey() this function returns a human readable (maybe translated) name
public
getDisplayName() : null|string
Tags
Return values
null|stringgetKey()
public
getKey() : string
Tags
Return values
string —defining the technical unique key
getPermissions()
public
getPermissions() : int
Tags
Return values
int —build up using \OCP\Constants
getUri()
In comparison to getKey() this function returns a unique uri within the scope of the principal
public
getUri() : string
Tags
Return values
stringisDeleted()
Whether the calendar is deleted
public
isDeleted() : bool
Tags
Return values
boolsearch()
public
search(string $pattern[, array<string|int, mixed> $searchProperties = [] ][, array<string|int, mixed> $options = [] ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, mixed>
Parameters
- $pattern : string
-
which should match within the $searchProperties
- $searchProperties : array<string|int, mixed> = []
-
defines the properties within the query pattern should match
- $options : array<string|int, mixed> = []
-
- 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
Return values
array<string|int, mixed> —an array of events/journals/todos which are arrays of key-value-pairs