Nextcloud Circles API

DeprecatedMember extends BaseMember
in package

Table of Contents

LEVEL_ADMIN  = 8
LEVEL_MEMBER  = 1
LEVEL_MODERATOR  = 4
LEVEL_NONE  = 0
LEVEL_OWNER  = 9
STATUS_BLOCKED  = 'Blocked'
STATUS_INVITED  = 'Invited'
STATUS_KICKED  = 'Removed'
STATUS_MEMBER  = 'Member'
STATUS_NONMEMBER  = 'Unknown'
STATUS_REQUEST  = 'Requesting'
TYPE_CONTACT  = 4
TYPE_GROUP  = 2
TYPE_MAIL  = 3
TYPE_USER  = 1
$broadcasting  : bool
$l10n  : IL10N
$cachedName  : string
$cachedUpdate  : int
$circleUniqueId  : string
$contactId  : string
$contactMeta  : array<string|int, mixed>
$instance  : string
$joined  : string
$joinedSince  : int
$level  : int
$memberId  : string
$note  : string
$status  : string
$type  : int
$userId  : string
__construct()  : mixed
BaseMember constructor.
addContactMeta()  : $this
addContactMetaArray()  : $this
addMemberToCircle()  : mixed
Update status of member like he joined a public circle.
alreadyExistOrJoining()  : bool
return if member already exists
broadcasting()  : mixed
cantBeOwner()  : mixed
fromArray()  : null|DeprecatedMember
fromJSON()  : DeprecatedMember
getCachedName()  : mixed
getCachedUpdate()  : int
getCircleId()  : string
getContactId()  : mixed
getContactMeta()  : array<string|int, mixed>
getInstance()  : mixed
getJoined()  : mixed
getJoinedSince()  : int
getLevel()  : mixed
getLevelString()  : mixed
getMemberId()  : mixed
getNote()  : mixed
getStatus()  : mixed
getType()  : int
getTypeName()  : mixed
getTypeString()  : mixed
getUserId()  : mixed
getViewerType()  : mixed
hasToBeAbleToJoinTheCircle()  : mixed
hasToBeHigherLevel()  : mixed
hasToBeInviteAble()  : mixed
hasToBeMember()  : mixed
hasToBeMemberOrAlmost()  : mixed
hasToBeModerator()  : mixed
inviteToCircle()  : mixed
isAlmostMember()  : mixed
isBroadcasting()  : bool
isLevel()  : mixed
joinCircle()  : mixed
jsonSerialize()  : mixed
levelHasToBeEditable()  : mixed
setCachedName()  : mixed
setCachedUpdate()  : mixed
setCircleId()  : $this
setContactId()  : mixed
setContactMeta()  : $this
setContactMetaArray()  : $this
setInstance()  : mixed
setJoined()  : mixed
setJoinedSince()  : mixed
setLevel()  : mixed
setMemberId()  : mixed
setNote()  : mixed
setStatus()  : $this
setType()  : mixed
setUserId()  : mixed
setAsAMember()  : mixed
inviteIntoClosedCircle()  : mixed
joinClosedCircle()  : mixed
Update status of member like he joined a closed circle (invite/request)

Constants

LEVEL_MODERATOR

public mixed LEVEL_MODERATOR = 4

STATUS_BLOCKED

public mixed STATUS_BLOCKED = 'Blocked'

STATUS_INVITED

public mixed STATUS_INVITED = 'Invited'

STATUS_KICKED

public mixed STATUS_KICKED = 'Removed'

STATUS_MEMBER

public mixed STATUS_MEMBER = 'Member'

STATUS_NONMEMBER

public mixed STATUS_NONMEMBER = 'Unknown'

STATUS_REQUEST

public mixed STATUS_REQUEST = 'Requesting'

Properties

$broadcasting

protected bool $broadcasting = true

$contactMeta

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

Methods

__construct()

BaseMember constructor.

public __construct([string $userId = '' ], int $type[, string $circleUniqueId = '' ]) : mixed
Parameters
$userId : string = ''
$type : int
$circleUniqueId : string = ''
Return values
mixed —

addContactMeta()

public addContactMeta(string $k, string $v) : $this
Parameters
$k : string
$v : string
Return values
$this —

addContactMetaArray()

public addContactMetaArray(string $k, string $v) : $this
Parameters
$k : string
$v : string
Return values
$this —

addMemberToCircle()

Update status of member like he joined a public circle.

public addMemberToCircle() : mixed
Return values
mixed —

alreadyExistOrJoining()

return if member already exists

public alreadyExistOrJoining() : bool
Return values
bool —

broadcasting()

public broadcasting(bool $able) : mixed
Parameters
$able : bool
Return values
mixed —

getCachedName()

public getCachedName() : mixed
Return values
mixed —

getCachedUpdate()

public getCachedUpdate() : int
Return values
int —

getCircleId()

public getCircleId() : string
Return values
string —

getContactId()

public getContactId() : mixed
Return values
mixed —

getContactMeta()

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

getInstance()

public getInstance() : mixed
Return values
mixed —

getJoined()

public getJoined() : mixed
Return values
mixed —

getJoinedSince()

public getJoinedSince() : int
Return values
int —

getLevel()

public getLevel() : mixed
Return values
mixed —

getLevelString()

public getLevelString() : mixed
Return values
mixed —

getMemberId()

public getMemberId() : mixed
Return values
mixed —

getNote()

public getNote() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getType()

public getType() : int
Return values
int —

getTypeName()

public getTypeName() : mixed
Return values
mixed —

getTypeString()

public getTypeString() : mixed
Return values
mixed —

getUserId()

public getUserId() : mixed
Return values
mixed —

getViewerType()

public getViewerType() : mixed
Return values
mixed —

inviteToCircle()

public inviteToCircle(mixed $circleType) : mixed
Parameters
$circleType : mixed
Return values
mixed —

isAlmostMember()

public isAlmostMember() : mixed
Return values
mixed —

isLevel()

public isLevel(mixed $level) : mixed
Parameters
$level : mixed
Return values
mixed —

jsonSerialize()

public jsonSerialize() : mixed
Return values
mixed —

setCachedName()

public setCachedName(mixed $display) : mixed
Parameters
$display : mixed
Return values
mixed —

setCachedUpdate()

public setCachedUpdate(int $time) : mixed
Parameters
$time : int
Return values
mixed —

setCircleId()

public setCircleId(string $circleUniqueId) : $this
Parameters
$circleUniqueId : string
Return values
$this —

setContactId()

public setContactId(mixed $contactId) : mixed
Parameters
$contactId : mixed
Return values
mixed —

setContactMeta()

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

setContactMetaArray()

public setContactMetaArray(string $k, array<string|int, mixed> $v) : $this
Parameters
$k : string
$v : array<string|int, mixed>
Return values
$this —

setInstance()

public setInstance(mixed $instance) : mixed
Parameters
$instance : mixed
Return values
mixed —

setJoined()

public setJoined(mixed $joined) : mixed
Parameters
$joined : mixed
Return values
mixed —

setJoinedSince()

public setJoinedSince(int $since) : mixed
Parameters
$since : int
Return values
mixed —

setLevel()

public setLevel(mixed $level) : mixed
Parameters
$level : mixed
Return values
mixed —

setMemberId()

public setMemberId(mixed $memberId) : mixed
Parameters
$memberId : mixed
Return values
mixed —

setNote()

public setNote(mixed $note) : mixed
Parameters
$note : mixed
Return values
mixed —

setStatus()

public setStatus( $status) : $this
Parameters
$status :
Return values
$this —

setType()

public setType(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed —

setUserId()

public setUserId(mixed $userId) : mixed
Parameters
$userId : mixed
Return values
mixed —

setAsAMember()

protected setAsAMember([mixed $level = 1 ]) : mixed
Parameters
$level : mixed = 1
Return values
mixed —

inviteIntoClosedCircle()

private inviteIntoClosedCircle() : mixed
Return values
mixed —

joinClosedCircle()

Update status of member like he joined a closed circle (invite/request)

private joinClosedCircle() : mixed
Return values
mixed —

Search results