gofile-apiwrapper v1.1.2

gofile-apiwrapper

api wrapper

Installation

$ npm install --save gofile-apiwrapper

Usage

const gofileApiwrapper = require('gofile-apiwrapper');
const api = new gofileApiwrapper.apiGofile("email","token");

// e.g.
api.getBestServer((err,body)=>{
    //body contain data 
    //err is null until https get request give error
});

documentation

Classes

Constants

Typedefs

apiGofile

api wrapper class for Gofile rest api

Kind: global class

• apiGofile
  • new apiGofile([email], [token])
  • .email
  • .token
  • .setEmail
  • .getEmail ⇒ string
  • .setToken
  • .getToken ⇒ string
  • .getBestServer(callback)
  • .getAccountInfo([token], callback)
  • .getUploadList([token], callback)
  • .deleteUpload([name], [code], [token], callback)
  • .deleteFile(name, [code], [token], callback)
  • .postUpload(file, [ac], [email], [description], [password], [tags], [expire], server, callback)

new apiGofile(email, token)

apiGofile.email

Kind: instance property of apiGofile Properties

apiGofile.token

Kind: instance property of apiGofile Properties

apiGofile.setEmail

setter of email

Kind: instance property of apiGofile

apiGofile.getEmail ⇒ string

getter of email

Kind: instance property of apiGofile Returns: string - email

apiGofile.setToken

setter of token

Kind: instance property of apiGofile

apiGofile.getToken ⇒ string

getter of token

Kind: instance property of apiGofile Returns: string - token

apiGofile.getBestServer(callback)

The server chosen with this function will have better connection quality.

Kind: instance method of apiGofile

apiGofile.getAccountInfo(token, callback)

Data returned are : email, account type (e.g. donor, standar), file count, file size.

Kind: instance method of apiGofile

apiGofile.getUploadList(token, callback)

Data returned are all upload with all data of file uploaded.

Kind: instance method of apiGofile

apiGofile.deleteUpload(name, code, token, callback)

It delete all upload containing the file name.

Kind: instance method of apiGofile

apiGofile.deleteFile(name, code, token, callback)

It delete all file in an upload or all upload if code of upload is not specified, if the upload have only 1 file use delete upload

Kind: instance method of apiGofile

apiGofile.postUpload(file, ac, email, description, password, tags, expire, server, callback)

If you specify the adminCode of an existing upload, then the file will be added to this upload.

Kind: instance method of apiGofile

baseUri : string

Kind: global constant Default: "https://apiv2.gofile.io/"

httpsResponse : function

Callback for getting response from https call

Kind: global typedef

License

MIT © BDream