Nextcloud Circles API

RemoteInstance extends NCSignatory
in package
implements IQueryRow, JsonSerializable Uses TArrayTools

Class AppService

Interfaces, Classes, Traits and Enums

IQueryRow
Interface IQueryRow
JsonSerializable

Table of Contents

ALIASES  = 'aliases'
AUTH_SIGNED  = 'auth-signed'
CIRCLE  = 'circle'
CIRCLES  = 'circles'
EVENT  = 'event'
INCOMING  = 'incoming'
INHERITED  = 'inherited'
MEMBER  = 'member'
MEMBERS  = 'members'
MEMBERSHIPS  = 'memberships'
ROOT  = 'root'
SHA256  = 'sha256'
SHA512  = 'sha512'
TEST  = 'test'
TYPE_EXTERNAL  = 'External'
TYPE_GLOBALSCALE  = 'GlobalScale'
TYPE_PASSIVE  = 'Passive'
TYPE_TRUSTED  = 'Trusted'
TYPE_UNKNOWN  = 'Unknown'
UID  = 'uid'
$LIST_TYPE  : mixed
$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$algorithm  : string
$aliases  : array<string|int, mixed>
$authSigned  : string
$circle  : string
$circles  : string
$dbId  : int
$event  : string
$id  : string
$identityAuthed  : bool
$incoming  : string
$inherited  : string
$instance  : string
$interface  : int
$keyId  : string
$keyOwner  : string
$member  : string
$members  : string
$memberships  : string
$origData  : array<string|int, mixed>
$privateKey  : string
$publicKey  : string
$root  : string
$test  : string
$type  : string
$uid  : string
__construct()  : mixed
NC22Signatory constructor.
getAlgorithm()  : string
getAliases()  : array<string|int, mixed>
getAuthSigned()  : string
getCircle()  : string
getCircles()  : string
getDbId()  : int
getEvent()  : string
getId()  : string
getIncoming()  : string
getInherited()  : string
getInstance()  : string
getInterface()  : int
getKeyId()  : string
getKeyOwner()  : string
getMember()  : string
getMembers()  : string
getMemberships()  : string
getOrigData()  : array<string|int, mixed>
getPrivateKey()  : string
getPublicKey()  : string
getRoot()  : string
getTest()  : string
getType()  : string
getUid()  : string
hasPrivateKey()  : bool
hasPublicKey()  : bool
import()  : NCSignatory
importFromDatabase()  : self
import data to feed the model.
isIdentityAuthed()  : bool
jsonSerialize()  : array<string|int, mixed>
mustBeIdentityAuthed()  : void
removeFragment()  : string
setAlgorithm()  : self
setAliases()  : RemoteInstance
setAuthSigned()  : RemoteInstance
setCircle()  : self
setCircles()  : self
setDbId()  : self
setEvent()  : self
setId()  : self
setIdentityAuthed()  : RemoteInstance
setIncoming()  : self
setInherited()  : self
setInstance()  : self
setInterface()  : RemoteInstance
setKeyId()  : self
setKeyOwner()  : self
setMember()  : self
setMembers()  : self
setMemberships()  : self
setOrigData()  : $this
/**
setPrivateKey()  : self
setPublicKey()  : self
setRoot()  : $this
setTest()  : RemoteInstance
setType()  : $this
setUid()  : RemoteInstance
setUidFromKey()  : $this
typeOf()  : string
validKey()  : bool
cleanArray()  : mixed
extractArray()  : mixed
get()  : string
getArray()  : array<string|int, mixed>
getBool()  : bool
getFloat()  : float
getInt()  : int
getList()  : array<string|int, mixed>
getObj()  : mixed
mustContains()  : mixed

Constants

Properties

$LIST_TYPE

public static mixed $LIST_TYPE = [self::TYPE_UNKNOWN, self::TYPE_PASSIVE, self::TYPE_EXTERNAL, self::TYPE_TRUSTED, self::TYPE_GLOBALSCALE]

$TYPE_ARRAY

public static mixed $TYPE_ARRAY = 'Array'

$TYPE_BOOLEAN

public static mixed $TYPE_BOOLEAN = 'Boolean'

$TYPE_INTEGER

public static mixed $TYPE_INTEGER = 'Integer'

$TYPE_SERIALIZABLE

public static mixed $TYPE_SERIALIZABLE = 'Serializable'

$TYPE_STRING

public static mixed $TYPE_STRING = 'String'

$origData

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

Methods

__construct()

NC22Signatory constructor.

public __construct([string $id = '' ]) : mixed
Parameters
$id : string = ''
Return values
mixed —

getAlgorithm()

public getAlgorithm() : string
Return values
string —

getAliases()

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

getAuthSigned()

public getAuthSigned() : string
Return values
string —

getCircle()

public getCircle() : string
Return values
string —

getCircles()

public getCircles() : string
Return values
string —

getId()

public getId() : string
Return values
string —

getIncoming()

public getIncoming() : string
Return values
string —

getInherited()

public getInherited() : string
Return values
string —

getInstance()

public getInstance() : string
Return values
string —

getInterface()

public getInterface() : int
Return values
int —

getKeyId()

public getKeyId() : string
Return values
string —

getKeyOwner()

public getKeyOwner() : string
Return values
string —

getMember()

public getMember() : string
Return values
string —

getMembers()

public getMembers() : string
Return values
string —

getMemberships()

public getMemberships() : string
Return values
string —

getOrigData()

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

getPrivateKey()

public getPrivateKey() : string
Return values
string —

getPublicKey()

public getPublicKey() : string
Return values
string —

getUid()

public getUid([bool $shorten = false ]) : string
Parameters
$shorten : bool = false
Return values
string —

hasPrivateKey()

public hasPrivateKey() : bool
Return values
bool —

hasPublicKey()

public hasPublicKey() : bool
Return values
bool —

importFromDatabase()

import data to feed the model.

public importFromDatabase(array<string|int, mixed> $data[, string $prefix = '' ]) : self
Parameters
$data : array<string|int, mixed>
$prefix : string = ''
Tags
throws
RemoteNotFoundException
Return values
self —

isIdentityAuthed()

public isIdentityAuthed() : bool
Return values
bool —

jsonSerialize()

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

removeFragment()

public static removeFragment(string $id) : string
Parameters
$id : string
Return values
string —

setAlgorithm()

public setAlgorithm(string $algorithm) : self
Parameters
$algorithm : string
Return values
self —

setCircle()

public setCircle(string $circle) : self
Parameters
$circle : string
Return values
self —

setCircles()

public setCircles(string $circles) : self
Parameters
$circles : string
Return values
self —

setDbId()

public setDbId(int $dbId) : self
Parameters
$dbId : int
Return values
self —

setEvent()

public setEvent(string $event) : self
Parameters
$event : string
Return values
self —

setId()

public setId(string $id) : self
Parameters
$id : string
Return values
self —

setIncoming()

public setIncoming(string $incoming) : self
Parameters
$incoming : string
Return values
self —

setInherited()

public setInherited(string $inherited) : self
Parameters
$inherited : string
Return values
self —

setInstance()

public setInstance(string $instance) : self
Parameters
$instance : string
Return values
self —

setKeyId()

public setKeyId(string $keyId) : self
Parameters
$keyId : string
Return values
self —

setKeyOwner()

public setKeyOwner(string $keyOwner) : self
Parameters
$keyOwner : string
Return values
self —

setMember()

public setMember(string $member) : self
Parameters
$member : string
Return values
self —

setMembers()

public setMembers(string $members) : self
Parameters
$members : string
Return values
self —

setMemberships()

public setMemberships(string $memberships) : self
Parameters
$memberships : string
Return values
self —

setOrigData()

/**

public setOrigData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>
Return values
$this —

setPrivateKey()

public setPrivateKey(string $privateKey) : self
Parameters
$privateKey : string
Return values
self —

setPublicKey()

public setPublicKey(string $publicKey) : self
Parameters
$publicKey : string
Return values
self —

setRoot()

public setRoot(string $root) : $this
Parameters
$root : string
Return values
$this —

setType()

public setType(string $type) : $this
Parameters
$type : string
Return values
$this —

setUidFromKey()

public setUidFromKey() : $this
Return values
$this —

typeOf()

public typeOf(string $key, array<string|int, mixed> $arr[, bool $root = true ]) : string
Parameters
$key : string
$arr : array<string|int, mixed>
$root : bool = true
Tags
throws
ItemNotFoundException
throws
UnknownTypeException
Return values
string —

validKey()

public validKey(string $k, array<string|int, mixed> $arr) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
Return values
bool —

cleanArray()

protected cleanArray(array<string|int, mixed> &$arr) : mixed
Parameters
$arr : array<string|int, mixed>
Return values
mixed —

extractArray()

protected extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed
Parameters
$k : string
$value : string
$list : array<string|int, mixed>
Tags
throws
ArrayNotFoundException
Return values
mixed —

get()

protected get(string $k, array<string|int, mixed> $arr[, string $default = '' ]) : string
Parameters
$k : string
$arr : array<string|int, mixed>
$default : string = ''
Return values
string —

getArray()

protected getArray(string $k, array<string|int, mixed> $arr[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getBool()

protected getBool(string $k, array<string|int, mixed> $arr[, bool $default = false ]) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
$default : bool = false
Return values
bool —

getFloat()

protected getFloat(string $k, array<string|int, mixed> $arr, float $default) : float
Parameters
$k : string
$arr : array<string|int, mixed>
$default : float
Return values
float —

getInt()

protected getInt(string $k, array<string|int, mixed> $arr, int $default) : int
Parameters
$k : string
$arr : array<string|int, mixed>
$default : int
Return values
int —

getList()

protected getList(string $k, array<string|int, mixed> $arr, array<string|int, mixed> $import[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$import : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getObj()

protected getObj(string $k, array<string|int, mixed> $arr[, JsonSerializable|null $default = null ]) : mixed
Parameters
$k : string
$arr : array<string|int, mixed>
$default : JsonSerializable|null = null
Return values
mixed —

mustContains()

protected mustContains(array<string|int, mixed> $keys, array<string|int, mixed> $arr) : mixed
Parameters
$keys : array<string|int, mixed>
$arr : array<string|int, mixed>
Tags
throws
MalformedArrayException
Return values
mixed —

Search results