comprodls-sdk 2.90.3-development → 2.91.0-thor

package/README.md

@@ -38,9 +38,7 @@ The SDK supports following APIs:
   <tbody>
     <tr><td>Auth API</td><td>http://auth.comprodls.com</td><td>1.0.0</td></tr>
     <tr><td>Product API</td><td>http://product.comprodls.com</td><td>1.0.0</td></tr>
-    <tr><td>Collab API</td><td>http://collab.comprodls.com</td><td>1.0.0</td></tr>
     <tr><td>Analytics API</td><td>http://analytics.comprodls.com</td><td>1.0.0</td></tr>
-    <tr><td>Activity / Test API</td><td>http://activity.comprodls.com</td><td>1.0.0</td></tr>
     <tr><td>xAPI</td><td>http://xapi.comprodls.com</td><td>1.0.0</td></tr>      
     <tr><td>Push Notifications</td><td>---</td><td>1.0.0</td></tr>
     <tr><td>Pub</td><td>http://pub.comprodls.com</td><td>1.0.0</td></tr>      
@@ -87,44 +85,9 @@ var comproDLS = require('comprodls-sdk').init();
 ### Authentication & Tokens
 Authentication (acquiring a valid token) is the first thing you need to do before using any function of comproDLS SDK. Following are the ways to authenticate:
 
-#### authWithCredentials
-You need valid comproDLS user credentials (organisationid, username and password) to use this method. Following is sample code to authenticate using credentials:
-```javascript
-comproDLS.authWithCredentials("myorg", {username:"myusername", password:"mypassword"}, {}).then(
-  function success(response) {
-    //You may persist token object in session/localstorage etc. for later usage.    	 
-    var token = response["token"];
-    console.log(token.expires_in);
-     
-    //user object contains user information
-    var user = response["user"];
-    console.log(user.name);
-    console.log(user.roles);
-	  
-    //org object contains organisation information
-    var org = response["user"]["org"];
-    console.log(org["type"]);
-  },
-  function error(err) {
-    var type = err["type"];
-    if (type == "API_ERROR") {
-    	if (err["httpcode"] == 401) {
-    		//Invalid Credentials
-    		console.log(err.message);
-    	}
-    } else  if (type == "SDK_ERROR") {
-    	console.log(err.message);
-    }
-  }
-);
-```
-After successfully calling this function, the comproDLS SDK object will have a valid authentication token which will be used across all subsequent calls. All other SDK functions do not require the token or credentials (to be supplied as parameters). Furthermore, in case the token expires, SDK will automatically refresh it using the original credentials. 
-
-See [authWithCredentials Documentation](https://github.com/comprodls/comprodls-sdk-js/wiki/02_Authentication-and-Tokens#authwithcredentials) for detailed information on method parameters, success and error response JSONs.
-
 #### authWithToken
 
-If you already have a persisted / saved comproDLS token (obtained via authWithCredentials method), you can use this method for a simple pass-through authentication (avoid generating a fresh token). Following is sample code:
+If you already have a persisted / saved comproDLS token, you can use this method for a simple pass-through authentication (avoid generating a fresh token). Following is sample code:
 ```javascript
 /*
  * saved_token is token object obtained previously via authWithCredentials method
@@ -212,105 +175,6 @@ auth.getUserProfile().then(
     }
   }
 );
-```
-#### ACTIVITY
-comproDLS Activity API provides functions to track assignment/test/activities and related data for scores, attempts, etc.
-**Note** You should have authenticated with comproDLS (authWithToken or authWithCredentials) before using these functions.  
-
-Following is an example of using ACTIVITY API SDK adaptor to get information of the activity. In this function, the SDK adaptor abstracts the knowledge of underlying REST URLs & Parameters, and offers a simpler interface. For a list of all SDK ACTIVITY functions, see [ACTIVITY Adaptor Documentation](https://github.com/comprodls/comprodls-sdk-js/wiki/09_ACTIVITY-Adaptor).
-
-```javascript
-var activity = comproDLS.Activity(productId, activityId, classId);
-
-/* Get all the attempts of an activity for a user */
-activity.getDetails().then(
-  function success(response) {
-  
-    var activity = response.activity;
-    /*--Activity {
-       activityid (string),
-       timestaken (integer),
-       timespent (integer),
-       timeallowed (integer),
-       savedstate (string),
-       attempts (Array[Attempt], optional)
-    }-- */
-}, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-/* Start the attempt and store the attempt id */
-activity.newAttempt(startParameters).then(
-  function success(response) {
-      var attempt = response["attempt"];
-      
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-/* Load In-process Attempt  */
-var attempt = activity.getAttempt(attemptId).then(
-  function success(response) {
-      var attempt = response["attempt"];
-      
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-// Save attempt state
-attempt.saveState(savedstate).then(
-  function success(response) {
-       var status = response.status;
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-// Retrieve attempt state
-attempt.getState().then(
-  function success(response) {
-       var state = response.state;
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-// Submit
-
-activity.submit(userresponse).then(
-  function success(response) {
-      var status = response.status;
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);
-
-
-<!--// Get scores
-activity.getAttemptScore().then(
-  function success(response) {
-  
-//get /{orgid}/{productid}/activity/{activityid} 
-//loop and return score for attempt.id
-      console.log("Success " + attempt.id);
-  }, 
-  function error(err) {
-     /* --- Error --- */   
-  }
-);-->
-
-
-)
-
 ```
 
 #### PUSH