Skip to content

Javascript API v1

Maxence Lange edited this page May 29, 2017 · 8 revisions

Calling the API:

in the PHP of your app, you will need to load the Circles.js: <?php script('circles', 'circles'); ?>

Then from your Javascript: var api = OCA.Circles.api;


Using the API:

api.createCircle(type, name, callback);

Create a new circle. You must specify type and name. type is one of this value:

CIRCLES_PERSONAL is 1 or 'personal';
CIRCLES_HIDDEN is 2 or 'hidden';
CIRCLES_PRIVATE is 4 or 'private';
CIRCLES_PUBLIC is 8 or 'public'; 

api.joinCircle(circleId, callback);

This function will make the current user to join a circle identified by its Id.

api.leaveCircle(circleId, callback);

api.searchCircles(type, name, level, callback);

api.destroyCircle(circleId, callback);

api.detailsCircle(circleId, callback);

api.addMember(circleId, userId, callback);

api.removeMember(circleId, userId, callback);

api.levelMember(circleId, userId, level, callback);

api.shareToCircle(circleId, source, type, item, callback);

api.linkCircle(circleId, remote, callback);

Clone this wiki locally