Merge pull request #18 from deltanet/issue/#16

Add custom statement listener and function
deltanet · Jul 30, 2020 · 308eba1 · 308eba1
2 parents a7adb65 + 8d6a4a4
commit 308eba1
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 3 deletions.
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "adapt-contrib-xapi",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "framework": ">=3",
   "homepage": "https://github.com/deltanet/adapt-contrib-xapi",
   "authors": [

diff --git a/example.json b/example.json
@@ -16,7 +16,8 @@
 				"router:menu": true,
 				"router:page": true,
 				"questionView:recordInteraction": true,
-				"assessments:complete": true
+				"assessments:complete": true,
+				"plugin:customStatement": true
 			},
 			"contentObjects": {
 				"change:_isComplete": true

diff --git a/js/adapt-contrib-xapi.js b/js/adapt-contrib-xapi.js
@@ -50,7 +50,8 @@ define([
         'router:page': false,
         'router:menu': false,
         'assessments:complete': true,
-        'questionView:recordInteraction': true
+        'questionView:recordInteraction': true,
+        "plugin:customStatement": true
       },
       contentObjects: {
         'change:_isComplete': false
@@ -478,6 +479,11 @@ define([
         this.listenTo(Adapt, 'assessments:complete', this.onAssessmentComplete);
       }
 
+      // Listen out for custom statements.
+      if (this.coreEvents['Adapt']['plugin:customStatement']) {
+        this.listenTo(Adapt, 'plugin:customStatement', this.onCustomStatement);
+      }
+
       // Standard completion events for the various collection types, i.e.
       // course, contentobjects, articles, blocks and components.
       _.each(_.keys(this.coreEvents), function(key) {
@@ -593,6 +599,10 @@ define([
           type = ADL.activityTypes.lesson;
           break;
         }
+        default: {
+          type = ADL.activityTypes[model.get('_type')];
+          break;
+        }
       }
 
       return type;
@@ -732,6 +742,51 @@ define([
       this.sendStatement(statement);
     },
 
+    /**
+    * Sends an xAPI statement when plugin triggers a custom statement.
+    * @param {AdaptModel} model - An instance of AdaptModel, i.e. ContentObjectModel, etc.
+    */
+
+    onCustomStatement: function(statementModel) {
+      var customResult = {};
+      var customContext = {};
+      // get the verb
+      var statement;
+      var customVerb = ADL.verbs[statementModel.get('verb')];
+
+      // get the object
+      var customIri = '';
+      if (statementModel.get('generateIri')) {
+        customIri = this.getUniqueIri(statementModel);
+      } else {
+        customIri = statementModel.get('_id');
+      }
+      var object = new ADL.XAPIStatement.Activity(customIri);
+      object.definition = {
+        name: this.getNameObject(statementModel),
+        type: this.getActivityType(statementModel)
+      };
+
+      // get result
+      // TODO
+
+      // get custom context
+      // TODO
+
+      statement = this.getStatement(this.getVerb(customVerb), object, customResult, customContext);
+
+      // add parent activity if part of assessment
+      if (statementModel && statementModel.get('_isPartOfAssessment')) {
+        var assessment = statementModel.assessment;
+        if (typeof assessment === 'object') {
+          statement.addParentActivity(this.getAssessmentObject(assessment));
+        }
+      }
+
+      this.addGroupingActivity(statementModel, statement)
+      this.sendStatement(statement);
+    },
+
     /**
      * Checks if a given component is blacklisted from sending statements.
      * @param {string} component - The name of the component.

diff --git a/properties.schema b/properties.schema
@@ -216,6 +216,15 @@
                           "title": "assessments:complete",
                           "validators": [],
                           "help": "Triggered when an individual assessment is completed."
+                        },
+                        "plugin:customStatement": {
+                          "type": "boolean",
+                          "required": false,
+                          "inputType": "Checkbox",
+                          "default": true,
+                          "title": "plugin:customStatement",
+                          "validators": [],
+                          "help": "Custom xAPI statement triggered by an individual plugin."
                         }
                       }
                     },