web-integration:client-side
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
web-integration:client-side [2019/08/05 12:39] tjotov [Advanced usage] |
web-integration:client-side [2019/08/05 12:44] tjotov [Communication] |
||
|---|---|---|---|
| Line 129: | Line 129: | ||
| See also source file "/ | See also source file "/ | ||
| - | ==== Page locators and rediects | + | ==== Communication |
| === Start operation URL === | === Start operation URL === | ||
| Tell Web API where your start operation is. | Tell Web API where your start operation is. | ||
| Line 153: | Line 153: | ||
| </ | </ | ||
| - | + | === Tell AJAX to use GET or POST === | |
| - | === Tell server | + | POST is used to deliver more data like transaction parameters |
| <sxh java> | <sxh java> | ||
| - | aducid.setGenerateQr | + | aducid.setAjaxMethod |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | === QR code targeting using jQuery | + | === Redirect URL for iOS typically provided by server side controler |
| <sxh java> | <sxh java> | ||
| - | aducid.setQrCode | + | aducid.setRedirectUrl |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | === QR code text hint jQuery | + | === Final action |
| + | What API should do when operation finishes (not processed on iOS as we use returnUrl directly there) | ||
| <sxh java> | <sxh java> | ||
| - | aducid.setQrHint | + | aducid.processResult |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | + | === Use push === | |
| - | === Init Params | + | Tell Web API if it should use push (QR code was used previously). |
| - | Method to pass more parameters like transaction amount, description, | + | |
| <sxh java> | <sxh java> | ||
| - | | + | |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | + | ==== UI methods ==== | |
| - | === Debug DOM to display internal messages | + | === Tell server to generate QR / or not to reduce payload |
| <sxh java> | <sxh java> | ||
| - | aducid.setDebug | + | aducid.setGenerateQr |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | + | === QR code targeting using jQuery | |
| - | === Tell AJAX to use GET or POST === | + | |
| - | POST is used to deliver more data like transaction parameters | + | |
| <sxh java> | <sxh java> | ||
| - | aducid.setAjaxMethod | + | aducid.setQrCode |
| - | | + | |
| } | } | ||
| </ | </ | ||
| - | === Redirect URL for iOS typically provided by server side controler | + | === QR code text hint jQuery |
| <sxh java> | <sxh java> | ||
| - | aducid.setRedirectUrl | + | aducid.setQrHint |
| - | | + | |
| } | } | ||
| </ | </ | ||
| Line 217: | Line 215: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | |||
| - | === 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 272: | Line 241: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | === 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 303: | Line 256: | ||
| 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(" | ||
| } | } | ||
| </ | </ | ||
web-integration/client-side.txt · Last modified: 2020/02/29 10:53 by mpospisek
Page Tools
