Skip to main content

Getting Started

Before You Begin​

This SDK is stored in the private npm repo and developed for use with the Cloudike Backend. If you need access, please Contacts Us

Requirements​

  • Node version — v12.16.3
  • Npm version — 6.14.4

Installation​

npm i

Initialization​

import CLFiles from '@cloudike/web_files';

let photosApp;

const options = {
    logLevel: 'error' // 'trace' | 'debug' | 'info' | 'warn' | 'error'
};

const config = {
    authToken: '', // user auth token optional
    baseUrl: '', // api base url required
    userAgent: '', // user agent name required
    wsConfig:{ //
        sockjs: '', // sockjs url optional
        sockjs_for_shares: "", // sockjs for shares url optional  
        websocket_event_groups: [
            "fs",
            "photos",
            "family"
        ], // websocket event groups optional, there are three groups: fs, photos, family
        jwt_token: '', // jwt token optional
        share_id: '', // share id optional
        auth_by_first_message: true // auth by first message optional
    }
}

try {
    filesApp = CLFiles.init(options, config);
} catch (e) {
    // catch files sdk InternalError
}

Dependencies​

Our SDK uses the following dependencies:

{
  "@cloudike/web_core": "0.7.4",
  "axios": "1.6.0",
  "lodash": "^4.17.21",
  "qs": "6.11.2",
  "sockjs-client": "1.6.1",
  "uuid": "9.0.1"
}