Nextcloud PHP API (master)

ICalendarQuery
in

Build a flexible, extendable query to the CalDAV backend

Tags
since
23.0.0

Table of Contents

Constants

SEARCH_PROPERTY_ATTENDEE  = 'ATTENDEE'
SEARCH_PROPERTY_CATEGORIES  = 'CATEGORIES'
SEARCH_PROPERTY_COMMENT  = 'COMMENT'
SEARCH_PROPERTY_CONTACT  = 'CONTACT'
SEARCH_PROPERTY_DESCRIPTION  = 'DESCRIPTION'
SEARCH_PROPERTY_LOCATION  = 'LOCATION'
SEARCH_PROPERTY_ORGANIZER  = 'ORGANIZER'
SEARCH_PROPERTY_RESOURCES  = 'RESOURCES'
SEARCH_PROPERTY_STATUS  = 'STATUS'
SEARCH_PROPERTY_SUMMARY  = 'SUMMARY'

Methods

addSearchCalendar()  : void
Limit the results to the calendar uri(s)
addSearchProperty()  : void
Define the property name(s) to search for
addType()  : void
setLimit()  : void
setOffset()  : void
setSearchPattern()  : void
Search the property values
setTimerangeEnd()  : void
setTimerangeStart()  : void

Constants

SEARCH_PROPERTY_ATTENDEE

public mixed SEARCH_PROPERTY_ATTENDEE = 'ATTENDEE'
Tags
since
24.0.0

SEARCH_PROPERTY_CATEGORIES

public mixed SEARCH_PROPERTY_CATEGORIES = 'CATEGORIES'
Tags
since
24.0.0

SEARCH_PROPERTY_COMMENT

public mixed SEARCH_PROPERTY_COMMENT = 'COMMENT'
Tags
since
24.0.0

SEARCH_PROPERTY_CONTACT

public mixed SEARCH_PROPERTY_CONTACT = 'CONTACT'
Tags
since
24.0.0

SEARCH_PROPERTY_DESCRIPTION

public mixed SEARCH_PROPERTY_DESCRIPTION = 'DESCRIPTION'
Tags
since
24.0.0

SEARCH_PROPERTY_LOCATION

public mixed SEARCH_PROPERTY_LOCATION = 'LOCATION'
Tags
since
24.0.0

SEARCH_PROPERTY_ORGANIZER

public mixed SEARCH_PROPERTY_ORGANIZER = 'ORGANIZER'
Tags
since
24.0.0

SEARCH_PROPERTY_RESOURCES

public mixed SEARCH_PROPERTY_RESOURCES = 'RESOURCES'
Tags
since
24.0.0

SEARCH_PROPERTY_STATUS

public mixed SEARCH_PROPERTY_STATUS = 'STATUS'
Tags
since
24.0.0

SEARCH_PROPERTY_SUMMARY

public mixed SEARCH_PROPERTY_SUMMARY = 'SUMMARY'
Tags
since
24.0.0

Methods

addSearchCalendar()

Limit the results to the calendar uri(s)

public addSearchCalendar(string $calendarUri) : void
Parameters
$calendarUri : string
Tags
since
23.0.0

addSearchProperty()

Define the property name(s) to search for

public addSearchProperty(string $value) : void

Note: Nextcloud only indexes some properties. You can not search for arbitrary properties.

Parameters
$value : string

any of the ICalendarQuery::SEARCH_PROPERTY_* values

Tags
psalm-param

ICalendarQuery::SEARCH_PROPERTY_* $value

since
23.0.0

addType()

public addType(string $value) : void
Parameters
$value : string
Tags
since
23.0.0

setLimit()

public setLimit(int $limit) : void
Parameters
$limit : int
Tags
since
23.0.0

setOffset()

public setOffset(int $offset) : void
Parameters
$offset : int
Tags
since
23.0.0

setSearchPattern()

Search the property values

public setSearchPattern(string $pattern) : void
Parameters
$pattern : string
Tags
since
23.0.0

setTimerangeEnd()

public setTimerangeEnd(DateTimeImmutable $endTime) : void
Parameters
$endTime : DateTimeImmutable
Tags
since
23.0.0

setTimerangeStart()

public setTimerangeStart(DateTimeImmutable $startTime) : void
Parameters
$startTime : DateTimeImmutable
Tags
since
23.0.0 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results