Differences

This shows you the differences between two versions of the page.

--- integration-api:detailed [2018/06/26 09:46]
tjotov
+++ integration-api:detailed [2018/06/26 09:57]
tjotov
@@ Line 58: / Line 58: @@
     }
-button with bound operation
+Button with bound operation
     aducid.setButton = function(param) {
         aducidButton = param;
@@ Line 95: / Line 95: @@
     }
+Text hint shown before operation started
     aducid.showQRHint = function(param) {
         if (qrHint != null) qrHint.html(localize("aducid_common_authenticateComment"));
     }
+How API can hide text hint
     aducid.hideQRHint = function(param) {
         if (qrHint != null) qrHint.html("");
     }
+Text hint shown after operation started
     aducid.showRunningHint = function(param) {
         if (qrHint != null) qrHint.html(localize("aducid_common_authenticationProgress"));
     }
+How API can hide text hint
     aducid.hideRunningHint = function(param) {
         if (qrHint != null) qrHint.html("");
     }
-    //Params
+The most important method - what API should do when operation finishes (not processed on iOS as we use returnUrl directly there)
-    var proxyParams = {
+    aducid.processResult = function(result) {
-        "publicMethod" : "GET_STATUS",
+        alert(result);
-        "id" : null
+    }
-    };
+How PEIG not installed is treated, marketplace redirect can be used here
+    aducid.showPeigError = function() {
+        alert("peig error - override this function")
+    }
+Auxiliary method to animate operation in progress
+    aducid.startAnimation = function() {
+        if (qrCode != null) {
+            qrCode.show();
+            qrCode.attr("src", "/aducid-resources/img/running.gif");
+        }
+    }
+Stop animation
+    aducid.stopRunningAnimation = function() {
+        if (qrCode == null) return;
+        qrCode.hide();
+    }
+This method controll progress bar animation. See aducid-api.js
+   this.startProgressBar = function(animationTime) {
+   }
+Hide QR timer progress bar
+    aducid.hideProgressBar = function() {
+        if (qrTimer == null) return;
+        qrTimer.hide();
+        qrTimer.html("");
+    }
+How errors are treated - use nice dialogues here
+    aducid.handleError = function(e) {
+        alert(e);
+    }

ADUCID 4.x

User Tools

Site Tools

Differences

Page Tools