Skip to content

adapt doc to new javascript api #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: source
Choose a base branch
from
Open

adapt doc to new javascript api #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9fc0c5
adapt doc to new javascript api
rom1504 Oct 14, 2016
ba15e64
adapt watch example in javascript
rom1504 Oct 27, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 31 additions & 62 deletions source/includes/_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ client.setCorpusPermissions(id_corpus, client.READ, group=id_group)
```

```javascript
Camomile.setCorpusPermissionsForUser(
id_corpus, id_user, Camomile.ADMIN, callback);
Camomile.setCorpusPermissionsForUser(
id_corpus, id_user, Camomile.WRITE, callback);
Camomile.setCorpusPermissionsForGroup(
id_corpus, id_group, Camomile.READ, callback);
client.setCorpusPermissionsForUser(
id_corpus, id_user, Camomile.ADMIN);
client.setCorpusPermissionsForUser(
id_corpus, id_user, Camomile.WRITE);
client.setCorpusPermissionsForGroup(
id_corpus, id_group, Camomile.READ);
```

The Camomile platform handles permissions: users may access only the resources for which they have enough permission.
Expand Down Expand Up @@ -116,12 +116,7 @@ assert corpora[0]._id == id_corpora[0]
```

```javascript
client.getCorpora(
function(id_corpora) {
do_something_with(id_corpora);
},
{returns_id: True}
);
client.getCorpora({returns_id: True}).then(id_corpora => { });
```

Each resource is given a unique identifier (`_id`) by MongoDB upon creation.
Expand All @@ -144,12 +139,7 @@ assert corpora[0].name == 'my corpus'
```

```javascript
client.getCorpora(
function(corpora) {

},
{filter: {name: 'my corpus'}}
);
client.getCorpora({filter: {name: 'my corpus'}}).then(corpora => { });
```

Most `get{Resource}` methods (e.g. `getCorpora`, `getLayers`, ...) support filtering by resource attribute.
Expand All @@ -171,13 +161,7 @@ do_something_with(corpus.history)
```

```javascript
client.getCorpus(
id_corpus,
function (corpus) {
do_something_with(corpus.history);
},
{history: True}
);
client.getCorpus(id_corpus, {history: True}).then(corpus => { });
```

The API keeps track of all changes made to corpora, media, layers and annotations, in a dedicated `history` attribute.
Expand Down Expand Up @@ -224,7 +208,7 @@ client.login(username, password)

```javascript
var server = 'http://example.com';
Camomile.setURL(server);
var client = new Camomile(server);
```

> JSON response upon success
Expand Down Expand Up @@ -288,7 +272,7 @@ client.update_password('new_password')
```

```javascript
client.update_password("new_password", callback);
client.update_password("new_password").then(() => { });
```

```http
Expand Down Expand Up @@ -342,9 +326,7 @@ user = client.createUser('username', 'password', role='user',
```

```javascript
client.createUser('username', 'password',
{'affiliation': 'LIMSI/CNRS', 'status': 'PhD student'}
'user', callback);
client.createUser('username', 'password', {'affiliation': 'LIMSI/CNRS', 'status': 'PhD student'}, 'user').then(() => {});
```


Expand Down Expand Up @@ -2380,9 +2362,7 @@ GET /corpus/555daefff80f910100d741d6/metadata/my.picture?file HTTP/1.1
```

```javascript
Camomile.getCorpusMetadata('555daefff80f910100d741d6', 'test2.child', function(err, datas) {
console.log(datas);
});
client.getCorpusMetadata('555daefff80f910100d741d6', 'test2.child').then(data => console.log(data));
```


Expand Down Expand Up @@ -2430,13 +2410,9 @@ client.getCorpusMetadataKeys(
```

```javascript
Camomile.getCorpusMetadataKeys('555daefff80f910100d741d6', function(err, datas) {
console.log(datas);
});
client.getCorpusMetadataKeys('555daefff80f910100d741d6').then(data => console.log(data));

Camomile.getCorpusMetadataKeys('555daefff80f910100d741d6', 'level1', function(err, datas) {
console.log(datas);
});
client.getCorpusMetadataKeys('555daefff80f910100d741d6', 'level1').then(data => console.log(data));
```

```http
Expand Down Expand Up @@ -2488,13 +2464,10 @@ POST /corpus/555daefff80f910100d741d6/metadata/ HTTP/1.1
```

```javascript
Camomile.setCorpusMetadata(
client.setCorpusMetadata(
'555daefff80f910100d741d6',
{'name': 'my metadata', 'level1': {'my_array': ['value1', 'value2']}} ,
function(err, success) {
console.log(success);
}
);
{'name': 'my metadata', 'level1': {'my_array': ['value1', 'value2']}}
).then(success => console.log(success));
```

> Sample JSON response
Expand Down Expand Up @@ -2538,14 +2511,11 @@ client.sendCorpusMetadataFile(
var inputFile = document.getElementById('file');
var file = inputFile.files[0];

Camomile.sendCorpusMetadataFile(
client.sendCorpusMetadataFile(
'555daefff80f910100d741d6',
'level1.mypicture',
file,
function(err, success) {
console.log(success);
}
);
file
).then(success => console.log(success));
```


Expand Down Expand Up @@ -2589,9 +2559,7 @@ DELETE /corpus/555daefff80f910100d741d6/metadata/level1 HTTP/1.1
```

```javascript
Camomile.deleteCorpusMetadata('555daefff80f910100d741d6', 'level1', function(err, success) {
console.log(success);
});
client.deleteCorpusMetadata('555daefff80f910100d741d6', 'level1').then(success => console.log(success));;
```

> Sample JSON response
Expand Down Expand Up @@ -2668,14 +2636,11 @@ client.watchCorpus('555daefff80f910100d741d6', callback)
```

```javascript
Camomile.listen(function(error, channel_id, event) {
var unwatchCorpus = event.watchCorpus('555daefff80f910100d741d6', function(error, data) {
console.log(data);

// For unwatch corpus:
unwatchCorpus();
});
});
var listener=function(error, data) {
console.log(error, data);
};

client.watchCorpus('555daefff80f910100d741d6', listener)
```

```http
Expand All @@ -2701,6 +2666,10 @@ DELETE /listen/:channel_id/:resource_type/:resource_id
client.unwatchCorpus('555daefff80f910100d741d6')
```

```javascript
client.unwatchCorpus('555daefff80f910100d741d6', listener);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to pass listener to unwatchCorpus?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you meant callback -- it does not have to be the same function as the one used for watchCorpus, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the same function passed to watchCorpus. https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener works that way, the function passed to addEvenListener needs to be passed to removeEventListener.
I guess the python API remove all the listeners ?

```

```http
DELETE /listen/5/medium/555daefff80f910100d741d6 HTTP/1.1

Expand Down