Nextcloud Circles API

BaseCircle
in package

Table of Contents

CIRCLES_ALL  = 15
CIRCLES_CLOSED  = 4
CIRCLES_PERSONAL  = 1
CIRCLES_PUBLIC  = 8
CIRCLES_SECRET  = 2
CIRCLES_SETTINGS_DEFAULT  = ['password_enforcement' => 'false', 'password_single' => '', 'allow_links' => 'false', 'allow_links_auto' => 'false', 'allow_links_files' => 'false']
SHORT_UNIQUE_ID_LENGTH  = 14
$l10n  : IL10N
$altName  : string
$contactAddressBook  : int
$contactGroupName  : string
$creation  : string
$description  : string
$groups  : array<string|int, DeprecatedMember>
$id  : int
$links  : array<string|int, FederatedLink>
$members  : array<string|int, DeprecatedMember>
$name  : string
$owner  : DeprecatedMember
$passwordSingle  : string
$settings  : array<string|int, mixed>
$type  : int
$uniqueId  : string
$viewer  : DeprecatedMember
$viewerGroup  : DeprecatedMember
__construct()  : mixed
generateUniqueId()  : mixed
getAltName()  : string
getContactAddressBook()  : int
getContactGroupName()  : string
getCreation()  : string
getDescription()  : string
getGroups()  : array<string|int, mixed>
getGroupViewer()  : DeprecatedMember
getHigherViewer()  : DeprecatedMember
getId()  : int
getLinks()  : array<string|int, mixed>
getMembers()  : array<string|int, DeprecatedMember>
getName()  : string
getOwner()  : DeprecatedMember
getPasswordSingle()  : string
getSetting()  : string|null
getSettings()  : array<string|int, mixed>|string
getType()  : string
getUniqueId()  : string
getViewer()  : DeprecatedMember
hasViewer()  : bool
setAltName()  : BaseCircle
setContactAddressBook()  : BaseCircle
setContactGroupName()  : BaseCircle
setCreation()  : BaseCircle
setDescription()  : BaseCircle
setGroups()  : BaseCircle
setGroupViewer()  : BaseCircle
setId()  : BaseCircle
setLinks()  : BaseCircle
setMembers()  : BaseCircle
setName()  : BaseCircle
setOwner()  : BaseCircle
setPasswordSingle()  : void
setSetting()  : mixed
setSettings()  : $this
setType()  : BaseCircle
setUniqueId()  : $this
setViewer()  : BaseCircle
typeInt()  : int

Constants

CIRCLES_PERSONAL

public mixed CIRCLES_PERSONAL = 1

CIRCLES_SETTINGS_DEFAULT

public mixed CIRCLES_SETTINGS_DEFAULT = ['password_enforcement' => 'false', 'password_single' => '', 'allow_links' => 'false', 'allow_links_auto' => 'false', 'allow_links_files' => 'false']

SHORT_UNIQUE_ID_LENGTH

public mixed SHORT_UNIQUE_ID_LENGTH = 14

Properties

$contactAddressBook

private int $contactAddressBook = 0

$contactGroupName

private string $contactGroupName = ''

$passwordSingle

private string $passwordSingle = ''

$settings

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

Methods

__construct()

public __construct([mixed $type = -1 ][, mixed $name = '' ]) : mixed
Parameters
$type : mixed = -1
$name : mixed = ''
Return values
mixed —

generateUniqueId()

public generateUniqueId() : mixed
Return values
mixed —

getAltName()

public getAltName() : string
Return values
string —

getContactAddressBook()

public getContactAddressBook() : int
Return values
int —

getContactGroupName()

public getContactGroupName() : string
Return values
string —

getCreation()

public getCreation() : string
Return values
string —

getDescription()

public getDescription() : string
Return values
string —

getGroups()

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

getId()

public getId() : int
Return values
int —

getLinks()

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

getName()

public getName([bool $real = false ]) : string
Parameters
$real : bool = false
Return values
string —

getPasswordSingle()

public getPasswordSingle() : string
Return values
string —

getSetting()

public getSetting(string $k) : string|null
Parameters
$k : string
Return values
string|null —

getSettings()

public getSettings([bool $json = false ]) : array<string|int, mixed>|string
Parameters
$json : bool = false
Return values
array<string|int, mixed>|string —

getType()

public getType() : string
Return values
string —

getUniqueId()

public getUniqueId([bool $full = false ]) : string
Parameters
$full : bool = false
Return values
string —

hasViewer()

public hasViewer() : bool
Return values
bool —

setContactAddressBook()

public setContactAddressBook(int $contactAddressBook) : BaseCircle
Parameters
$contactAddressBook : int
Return values
BaseCircle —

setContactGroupName()

public setContactGroupName(string $contactGroupName) : BaseCircle
Parameters
$contactGroupName : string
Return values
BaseCircle —

setGroups()

public setGroups(array<string|int, mixed> $groups) : BaseCircle
Parameters
$groups : array<string|int, mixed>
Return values
BaseCircle —

setLinks()

public setLinks(array<string|int, mixed> $links) : BaseCircle
Parameters
$links : array<string|int, mixed>
Return values
BaseCircle —

setMembers()

public setMembers(array<string|int, mixed> $members) : BaseCircle
Parameters
$members : array<string|int, mixed>
Return values
BaseCircle —

setPasswordSingle()

public setPasswordSingle(string $passwordSingle) : void
Parameters
$passwordSingle : string
Return values
void —

setSetting()

public setSetting(string $k, mixed $v) : mixed
Parameters
$k : string
$v : mixed
Return values
mixed —

setSettings()

public setSettings(string|array<string|int, mixed> $settings[, bool $all = false ]) : $this
Parameters
$settings : string|array<string|int, mixed>
$all : bool = false
Return values
$this —

setUniqueId()

public setUniqueId(string $uniqueId) : $this
Parameters
$uniqueId : string
Return values
$this —

typeInt()

public static typeInt(int|string $type) : int
Parameters
$type : int|string
Return values
int —

Search results