Package Exports
- owncloud-sdk
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (owncloud-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Use this light-weight JS library with a promise-based interface for seamless communication with your ownCloud instance.
Supports only browser JS but requires JavaScript techniques like webpack to compile it properly.
For Node.js please have a look at this tag.
Install
$ npm install owncloud-sdkUsage
const owncloud = require('owncloud-sdk');
let oc = new owncloud({
baseUrl: config.owncloudURL,
auth: {
basic: {
username: config.username,
password: config.password
}
}
});
// Login
oc.login().then(status => {
// STUFF
}).catch(error => {
// HANDLE ERROR
});
// Share File With Link
oc.shares.shareFileWithLink('linkToYourFile').then(shareInfo => {
console.log("Link is : " + shareInfo.getLink());
}).catch(error => {
// HANDLE ERROR
});
// List all files
oc.files.list('/path/to/file/folder').then(files => {
console.log(files);
}).catch(error => {
console.log(error);
});Example Projects
ownCloud web
ownCloud web will be the next generation web frontend for ownCloud. It uses owncloud-sdk.
All Methods Available
Full API documentation is available at
Building the Documentation
JSDocs
To build the jsdocs, type this command and follow the instructions on the terminal:
$ yarn build:docsUnit tests
The following command will run all unit tests. Before running the command, make sure you have edited the owncloud/test/config.json file accordingly.
$ yarn testTeam
|
Noveen Sachdeva |
Vincent Petry |
Thomas Müller |
