diff options
author | Maxence Lange <maxence@pontapreta.net> | 2017-02-21 01:47:30 +0300 |
---|---|---|
committer | Maxence Lange <maxence@pontapreta.net> | 2017-02-21 01:47:30 +0300 |
commit | 1e2e44cfe4596fcae1c6a7eca7a97193293642d3 (patch) | |
tree | 02a445de6bfd29919d66e29ea15e605afc7fcb6f /README.md | |
parent | ea69e6c31041d0835af619392f919b55db45d064 (diff) |
api
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 34 insertions, 2 deletions
@@ -41,7 +41,7 @@ How to include the Circles.js in your templates: **Create a Circle** > OCA.Circles.api.createCircle(name, type, callback); ```javascript -OCA.Circles.api.createCircle('test-public', 8, creationDone); +OCA.Circles.api.createCircle('test-public', 'public', creationDone); function creationDone(result) { console.log('status: ' + JSON.stringify(result)); @@ -49,15 +49,47 @@ function creationDone(result) ``` +**Listing Circles** +> OCA.Circles.api.listCircle(type, callback); +```javascript +OCA.Circles.api.listCircles('all', listingDone); +function listingDone(result) +{ + console.log('status: ' + JSON.stringify(result)); +} +``` + + +**Details of a Circle** +> OCA.Circles.api.detailsCircle(circle_id, callback); +```javascript +OCA.Circles.api.detailsCircle(42, detailsCircleResult); +function detailsCircleResult(result) +{ + console.log('status: ' + JSON.stringify(result)); +} +``` + + + ### PHP - list of API calls -** Create a Circle** +**Create a Circle** > $result = OCA\Circles\Api\Circles::createCircle($name, $type); +**Listing Circles** +> $result = OCA\Circles\Api\Circles::listCircles($name, $type); + + + +**Details of a Circle** +> $result = OCA\Circles\Api\Circles::detailsCircle($circle_id); + + # Credits App Icon by [http://www.flaticon.com/authors/madebyoliver](Madebyoliver) under Creative Commons BY 3.0 |