You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Javascript SDK for communicating with Cells server
2
+
3
+
Javascript SDK for communicating with Cells server.
4
+
5
+
This SDK is generated automatically using `swagger-codegen` tool from the OpenAPI specification of Cells Rest API. It does not rely on any framework and uses superagent internally for performing HTTP requests.
6
+
7
+
Since Cells v3, it is used internally by the official Pydio Cells web interface (written in React).
8
+
9
+
## Usage
10
+
11
+
### Installation
12
+
13
+
Simply use `npm install --save cells-sdk` to append the latest version to your package.json.
14
+
15
+
### Authentication
16
+
17
+
Authentication is passed via the `Authorization: Bearer $TOKEN` header, where `$TOKEN` can be a Personal Access Token, or retrieved dynamically by the frontend login process.
18
+
19
+
### Endpoints
20
+
21
+
All APIs described in Cells official documentation are supported. Below are listed the main services available :
22
+
23
+
- ACLService
24
+
- ActivityService
25
+
- AdminTreeService
26
+
- ConfigService
27
+
- FrontendService
28
+
- GraphService
29
+
- InstallService
30
+
- JobsService
31
+
- LogService
32
+
- MailerService
33
+
- MetaService
34
+
- PolicyService
35
+
- RoleService
36
+
- SearchService
37
+
- ShareService
38
+
- TemplatesService
39
+
- TokenService
40
+
- TreeService
41
+
- UpdateService
42
+
- UserMetaService
43
+
- UserService
44
+
- WorkspaceService
45
+
46
+
Please refer to the docs for more information.
47
+
48
+
### Example
49
+
50
+
A sample application is available in example/app.js
51
+
52
+
Basic tree listing looks like :
53
+
54
+
```javascript
55
+
var api =newTreeServiceApi(client);
56
+
var request =newRestGetBulkMetaRequest();
57
+
request.NodePaths= ['/folder/*'];
58
+
api.bulkStatNodes(request).then(res=> {
59
+
// Read array res.Nodes with all nodes
60
+
});
61
+
```
62
+
63
+
## License
64
+
65
+
This library is licensed under Apache V2.0 license.
0 commit comments