This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
web-integration:client-side [2019/08/05 12:40] tjotov [Page locators and rediects] |
web-integration:client-side [2020/02/29 10:53] (current) mpospisek [Web Integration API - Example] |
||
|---|---|---|---|
| Line 52: | Line 52: | ||
| ===== Web Integration API - Example ===== | ===== Web Integration API - Example ===== | ||
| - | <code html> | + | <sxh html> |
| <html xmlns=" | <html xmlns=" | ||
| Line 122: | Line 122: | ||
| </ | </ | ||
| - | </code> | + | </sxh> |
| Line 161: | Line 161: | ||
| </ | </ | ||
| - | === Redirect URL for iOS typically provided | + | === Redirect URL set by GUI === |
| + | This is usuallly set by server side but can be also managed from client side. Server side has higher priority. | ||
| <sxh java> | <sxh java> | ||
| aducid.setRedirectUrl = function(param) { | aducid.setRedirectUrl = function(param) { | ||
| Line 168: | Line 169: | ||
| </ | </ | ||
| + | === Error redirect URL set by GUI === | ||
| + | This is usuallly set by server side but can be also managed from client side. Server side has higher priority. | ||
| + | <sxh java> | ||
| + | aducid.setErrorPage = function(param) { | ||
| + | errorPage = param; | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Final action === | ||
| + | What API should do when operation finishes (not processed on iOS as we use returnUrl directly there) | ||
| + | <sxh java> | ||
| + | aducid.processResult = function(result) { | ||
| + | alert(result); | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Use push === | ||
| + | Tell Web API if it should use push (QR code was used previously). | ||
| + | <sxh java> | ||
| + | this.setPush = function(param) { | ||
| + | push = param == true; | ||
| + | } | ||
| + | </ | ||
| ==== UI methods ==== | ==== UI methods ==== | ||
| === Tell server to generate QR / or not to reduce payload === | === Tell server to generate QR / or not to reduce payload === | ||
| Line 189: | Line 213: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | |||
| - | ==== Advance methods ==== | ||
| - | === Init Params === | ||
| - | Method to pass more parameters like transaction amount, description, | ||
| - | <sxh java> | ||
| - | aducid.setInitParams = function(param) { | ||
| - | initParams = param; | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | === Debug DOM to display internal messages === | ||
| - | <sxh java> | ||
| - | aducid.setDebug = function(param) { | ||
| - | aducidDebug = param; | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | |||
| - | |||
| === Button bound operation === | === Button bound operation === | ||
| Line 220: | Line 224: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | |||
| - | === Get last binding mode === | ||
| - | <sxh java> | ||
| - | aducid.getSessionBinding = function() { | ||
| - | return localStorage[' | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | === Is binding URI? === | ||
| - | <sxh java> | ||
| - | aducid.isURI = function() { | ||
| - | return instance.getSessionBinding() == " | ||
| - | } | ||
| - | </ | ||
| - | | ||
| - | === Is binding QR? === | ||
| - | <sxh java> | ||
| - | aducid.isQR = function() { | ||
| - | return instance.getSessionBinding() == " | ||
| - | } | ||
| - | |||
| - | === Is this operation going to be authentication (i.e. first operation in chain)? === | ||
| - | <sxh java> | ||
| - | aducid.setAuthentication = function() { | ||
| - | instance.setSessionBinding(null); | ||
| - | } | ||
| - | </ | ||
| - | |||
| === Text hint shown before operation started === | === Text hint shown before operation started === | ||
| <sxh java> | <sxh java> | ||
| Line 275: | Line 250: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | === The most important method === | ||
| - | What API should do when operation finishes (not processed on iOS as we use returnUrl directly there) | ||
| - | <sxh java> | ||
| - | aducid.processResult = function(result) { | ||
| - | alert(result); | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | === How PEIG not installed is treated, marketplace redirect can be used here === | ||
| - | <sxh java> | ||
| - | aducid.showPeigError = function() { | ||
| - | alert(" | ||
| - | } | ||
| - | </ | ||
| - | |||
| === Auxiliary method to animate operation in progress === | === Auxiliary method to animate operation in progress === | ||
| <sxh java> | <sxh java> | ||
| Line 306: | Line 265: | ||
| if (qrCode == null) return; | if (qrCode == null) return; | ||
| qrCode.hide(); | qrCode.hide(); | ||
| + | } | ||
| + | </ | ||
| + | ==== Advanced methods ==== | ||
| + | === Init Params === | ||
| + | Method to pass more parameters like transaction amount, description, | ||
| + | <sxh java> | ||
| + | aducid.setInitParams = function(param) { | ||
| + | initParams = param; | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Debug DOM to display internal messages === | ||
| + | <sxh java> | ||
| + | aducid.setDebug = function(param) { | ||
| + | aducidDebug = param; | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Is binding URI? === | ||
| + | <sxh java> | ||
| + | aducid.isURI = function() { | ||
| + | return instance.getSessionBinding() == " | ||
| + | } | ||
| + | </ | ||
| + | | ||
| + | === Is binding QR? === | ||
| + | <sxh java> | ||
| + | aducid.isQR = function() { | ||
| + | return instance.getSessionBinding() == " | ||
| + | } | ||
| + | |||
| + | === Is this operation going to be authentication (i.e. first operation in chain)? === | ||
| + | <sxh java> | ||
| + | aducid.setAuthentication = function() { | ||
| + | instance.setSessionBinding(null); | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Get last binding mode === | ||
| + | <sxh java> | ||
| + | aducid.getSessionBinding = function() { | ||
| + | return localStorage[' | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === How PEIG not installed is treated, marketplace redirect can be used here === | ||
| + | <sxh java> | ||
| + | aducid.showPeigError = function() { | ||
| + | alert(" | ||
| } | } | ||
| </ | </ | ||