Nextcloud Circles API

BasicProbe
in package
implements IQueryProbe

Class BasicProbe

Interfaces, Classes, Traits and Enums

IQueryProbe
Interface IQueryProbe

Table of Contents

DETAILS_ALL  = 127
DETAILS_NONE  = 0
DETAILS_POPULATION  = 32
$details  : int
$filterCircle  : Circle
$filterMember  : Member
$filterRemoteInstance  : RemoteInstance
$itemsLimit  : int
$itemsOffset  : int
$options  : array<string|int, mixed>
addDetail()  : $this
addOption()  : $this
addOptionBool()  : $this
addOptionInt()  : $this
getAsOptions()  : array<string|int, mixed>
getDetails()  : int
getFilterCircle()  : Circle
getFilterMember()  : Member
getFilterRemoteInstance()  : RemoteInstance
getItemsLimit()  : int
getItemsOffset()  : int
hasFilterCircle()  : bool
hasFilterMember()  : bool
hasFilterRemoteInstance()  : bool
JsonSerialize()  : array<string|int, mixed>
setDetails()  : $this
setFilterCircle()  : CircleProbe
setFilterMember()  : CircleProbe
setFilterRemoteInstance()  : CircleProbe
setItemsLimit()  : BasicProbe
setItemsOffset()  : BasicProbe
showDetail()  : bool

Constants

DETAILS_POPULATION

public mixed DETAILS_POPULATION = 32

Properties

$options

private array<string|int, mixed> $options = []

Methods

addDetail()

public addDetail(int $detail) : $this
Parameters
$detail : int
Return values
$this —

addOption()

public addOption(string $key, string $value) : $this
Parameters
$key : string
$value : string
Return values
$this —

addOptionBool()

public addOptionBool(string $key, bool $value) : $this
Parameters
$key : string
$value : bool
Return values
$this —

addOptionInt()

public addOptionInt(string $key, int $value) : $this
Parameters
$key : string
$value : int
Return values
$this —

getAsOptions()

public getAsOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getDetails()

public getDetails() : int
Return values
int —

getItemsLimit()

public getItemsLimit() : int
Return values
int —

getItemsOffset()

public getItemsOffset() : int
Return values
int —

hasFilterCircle()

public hasFilterCircle() : bool
Return values
bool —

hasFilterMember()

public hasFilterMember() : bool
Return values
bool —

hasFilterRemoteInstance()

public hasFilterRemoteInstance() : bool
Return values
bool —

JsonSerialize()

public JsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setDetails()

public setDetails(int $details) : $this
Parameters
$details : int
Return values
$this —

showDetail()

public showDetail(int $detail) : bool
Parameters
$detail : int
Return values
bool —

Search results