mirror of
https://github.com/netzbegruenung/circles.git
synced 2024-05-06 05:33:41 +02:00
appinfo | ||
css | ||
img | ||
js | ||
lib | ||
screenshots | ||
templates | ||
tests | ||
vendor | ||
.gitignore | ||
.scrutinizer.yml | ||
composer.json | ||
composer.lock | ||
LICENSE | ||
README.md |
Nextcloud Circles
Bring cloud-users closer together.
Circles allows your users to create their own groups of users/colleagues/friends. Those groups of users (or circles) can then be used by any other app for sharing purpose (files, social feed, status update, messaging, ...)
Differents type of circles can be created:
- A Personal Circle is a list of users known only to yourself. Use this if you want to send messsage or share thing repeatedly to the same group of people.
- Hidden Circle is an open group that can be protected by a password. Select this circle to create a community not displayed as a Public Circle.
- A Private Circle require an invitation or a confirmation from an admin. This is the best circle if you are looking for privacy when sharing your files or your ideas.
- A Public Circle is an open group visible to anyone that dare to join. Your circle will be visible to everyone and everyone will be able to join the circle.
API
CIRCLES_PERSONAL is 1 or 'personal';
CIRCLES_HIDDEN is 2 or 'hidden';
CIRCLES_PRIVATE is 4 or 'private';
CIRCLES_PUBLIC is 8 or 'public';
Javascript - list of API calls:
How to include the Circles.js in your templates:
<?php script('circles', 'circles'); ?>
Create a Circle
OCA.Circles.api.createCircle(type, name, callback);
OCA.Circles.api.createCircle('public', 'test-public', creationDone);
function creationDone(result)
{
console.log('status: ' + JSON.stringify(result));
}
Listing Circles
OCA.Circles.api.listCircle(type, callback);
OCA.Circles.api.listCircles('all', listingDone);
function listingDone(result)
{
console.log('status: ' + JSON.stringify(result));
}
Searching Circles
OCA.Circles.api.listCircle(type, callback);
OCA.Circles.api.searchCircles('all', 'test', listingDone);
function listingDone(result)
{
console.log('status: ' + JSON.stringify(result));
}
Details of a Circle
OCA.Circles.api.detailsCircle(circle_id, callback);
OCA.Circles.api.detailsCircle(42, detailsCircleResult);
function detailsCircleResult(result)
{
console.log('status: ' + JSON.stringify(result));
}
PHP - list of API calls
Create a Circle
$result = OCA\Circles\Api\Circles::createCircle($type, $name);
Listing Circles/Searching Circles
$result = OCA\Circles\Api\Circles::listCircles($type, [$name]);
Details of a Circle
$result = OCA\Circles\Api\Circles::detailsCircle($circle_id);
Credits
App Icon by http://www.flaticon.com/authors/madebyoliver under Creative Commons BY 3.0