Nextcloud Circles API

Circles
in package

Table of Contents

API_VERSION  = [0, 10, 0]
CIRCLES_ALL  = 15
CIRCLES_CLOSED  = 4
CIRCLES_PERSONAL  = 1
CIRCLES_PUBLIC  = 8
CIRCLES_SECRET  = 2
LEVEL_ADMIN  = \OCA\Circles\Model\Member::LEVEL_ADMIN
LEVEL_MEMBER  = \OCA\Circles\Model\Member::LEVEL_MEMBER
LEVEL_MODERATOR  = \OCA\Circles\Model\Member::LEVEL_MODERATOR
LEVEL_NONE  = \OCA\Circles\Model\Member::LEVEL_NONE
LEVEL_OWNER  = \OCA\Circles\Model\Member::LEVEL_OWNER
TYPE_CONTACT  = \OCA\Circles\Model\Member::TYPE_CONTACT
TYPE_GROUP  = \OCA\Circles\Model\Member::TYPE_GROUP
TYPE_MAIL  = \OCA\Circles\Model\Member::TYPE_MAIL
TYPE_USER  = \OCA\Circles\Model\Member::TYPE_USER
detailsCircle()  : Circle
getFilesForCircles()  : array<string|int, string>
getMember()  : Membership
joinedCircles()  : array<string|int, Circle>
listCircles()  : array<string|int, Circle>
Circles::listCircles();

Constants

API_VERSION

public mixed API_VERSION = [0, 10, 0]

CIRCLES_ALL

public mixed CIRCLES_ALL = 15

CIRCLES_CLOSED

public mixed CIRCLES_CLOSED = 4

CIRCLES_PERSONAL

public mixed CIRCLES_PERSONAL = 1

CIRCLES_PUBLIC

public mixed CIRCLES_PUBLIC = 8

CIRCLES_SECRET

public mixed CIRCLES_SECRET = 2

LEVEL_ADMIN

public mixed LEVEL_ADMIN = \OCA\Circles\Model\Member::LEVEL_ADMIN

LEVEL_MEMBER

public mixed LEVEL_MEMBER = \OCA\Circles\Model\Member::LEVEL_MEMBER

LEVEL_MODERATOR

public mixed LEVEL_MODERATOR = \OCA\Circles\Model\Member::LEVEL_MODERATOR

LEVEL_NONE

public mixed LEVEL_NONE = \OCA\Circles\Model\Member::LEVEL_NONE

LEVEL_OWNER

public mixed LEVEL_OWNER = \OCA\Circles\Model\Member::LEVEL_OWNER

TYPE_CONTACT

public mixed TYPE_CONTACT = \OCA\Circles\Model\Member::TYPE_CONTACT

TYPE_GROUP

public mixed TYPE_GROUP = \OCA\Circles\Model\Member::TYPE_GROUP

TYPE_MAIL

public mixed TYPE_MAIL = \OCA\Circles\Model\Member::TYPE_MAIL

TYPE_USER

public mixed TYPE_USER = \OCA\Circles\Model\Member::TYPE_USER

Methods

detailsCircle()

public static detailsCircle(string $circleUniqueId[, bool $forceAll = false ]) : Circle
Parameters
$circleUniqueId : string
$forceAll : bool = false
Tags
throws
CircleNotFoundException
throws
FederatedUserException
throws
FederatedUserNotFoundException
throws
InitiatorNotFoundException
throws
InvalidIdException
throws
RequestBuilderException
throws
SingleCircleNotFoundException
deprecated
  • used by apps/dav/lib/Connector/Sabre/Principal.php - used by apps/files_sharing/lib/Controller/ShareAPIController.php - used by lib/private/Share20/Manager.php

Circles::detailsCircle();

WARNING - This function is called by the core - WARNING Do not change it

Returns details on the circle. If the current user is a member, the members list will be return as well.

Return values
Circle —

getFilesForCircles()

public static getFilesForCircles(array<string|int, mixed> $circleUniqueIds) : array<string|int, string>
Parameters
$circleUniqueIds : array<string|int, mixed>
Tags
deprecated
  • used by apps/dav/lib/Connector/Sabre/FilesReportPlugin.php

Get a list of objects which are shred with $circleUniqueId.

since
0.14.0
Return values
array<string|int, string> —

array of object ids or empty array if none found

getMember()

public static getMember(string $circleUniqueId, string $ident, int $type[, bool $forceAll = false ]) : Membership
Parameters
$circleUniqueId : string
$ident : string
$type : int
$forceAll : bool = false
Tags
deprecated
  • used by apps/files_sharing/lib/Controller/ShareAPIController.php

Circles::getMember();

This function will return information on a member of the circle. Current user need at least to be Member.

Return values
Membership —

joinedCircles()

public static joinedCircles([string $userId = '' ][, bool $forceAll = false ]) : array<string|int, Circle>
Parameters
$userId : string = ''
$forceAll : bool = false
Tags
throws
FederatedUserException
throws
FederatedUserNotFoundException
throws
InitiatorNotFoundException
throws
InvalidIdException
throws
RequestBuilderException
throws
SingleCircleNotFoundException
deprecated
  • used by apps/dav/lib/Connector/Sabre/Principal.php

Circles::joinedCircles();

Return all the circle the current user is a member.

Return values
array<string|int, Circle> —

listCircles()

Circles::listCircles();

public static listCircles(mixed $type[, string $name = '' ], int $level[, string $userId = '' ][, bool $forceAll = false ]) : array<string|int, Circle>

This function list all circles fitting a search regarding its name and the level and the rights from the current user. In case of Secret circle, name needs to be complete so the circle is included in the list (or if the current user is the owner)

example: Circles::listCircles(Circles::CIRCLES_ALL, '', 8, callback); will returns all circles when the current user is at least an Admin.

Parameters
$type : mixed
$name : string = ''
$level : int
$userId : string = ''
$forceAll : bool = false
Return values
array<string|int, Circle> —

Search results