kco-mobile-sdk
Version:
Simple integration of Klarna Checkout into hybrid iOS and Android apps
452 lines (451 loc) • 17 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_76-release) on Wed Oct 19 16:47:55 CEST 2016 -->
<title>KlarnaCheckout</title>
<meta name="date" content="2016-10-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KlarnaCheckout";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/klarna/checkout/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/klarna/checkout/KlarnaCheckout.html" target="_top">Frames</a></li>
<li><a href="KlarnaCheckout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.klarna.checkout</div>
<h2 title="Class KlarnaCheckout" class="title">Class KlarnaCheckout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.klarna.checkout.KlarnaCheckout</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">KlarnaCheckout</span>
extends java.lang.Object</pre>
<div class="block"><b>Primary checkout object for merchant integration.
<p/>
Standard "embedded" checkout initialization:</b><br>
KlarnaCheckout checkout = new KlarnaCheckout( myCurrentActivity );<br>
checkout.setSignalListener(..an implementation of the <a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout"><code>SignalListener</code></a> interface..);<br>
checkout.loadCheckoutSnippet( ..the html snippet from merchant server.. );<br>
WebView webView = (WebView) checkout.getView();<br><br>
(the returned WebView can then be placed in layout placeholder or fragment as required)<br>
<p/>
<b>"Hybrid" checkout initialization:</b><br>
KlarnaCheckout checkout = new KlarnaCheckout( myCurrentActivity );<br>
checkout.setWebView( myMerchantWebView );<br>
checkout.setSignalListener(..an implementation of the SignalListener interface..);<br>
myMerchantWebView.loadUrl( "http://my_merchant_url" );<br><br>
<i>("myMerchantWebView" is a <code>WebView</code> instance that has loaded a web page which
already contains the checkout code snippet)</i><br>
<p/>
<b>Disposal:</b><br>
When checkout is no longer needed you can call checkout's destroy method.<br><br>
checkout.destroy();<br><br>
NOTE: if using hybrid the main webView will not be destroyed. However the one created when
using the embedded implementation will.<br></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout"><code>SignalListener</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#KlarnaCheckout-android.app.Activity-">KlarnaCheckout</a></span>(android.app.Activity currentActivity)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#KlarnaCheckout-android.app.Activity-java.lang.String-">KlarnaCheckout</a></span>(android.app.Activity currentActivity,
java.lang.String redirectURI)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#destroy--">destroy</a></span>()</code>
<div class="block">Method to destroy checkout and remove all resources.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>android.view.View</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#getView--">getView</a></span>()</code>
<div class="block">Returns the currentcheckout view} instance</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#resume--">resume</a></span>()</code>
<div class="block">Sends message to checkout to resume operations.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#setGooglePushMessageToken-java.lang.String-">setGooglePushMessageToken</a></span>(java.lang.String token)</code>
<div class="block">Sets google push messaging token if using with Klarna's GCM</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#setSignalListener-com.klarna.checkout.SignalListener-">setSignalListener</a></span>(<a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout">SignalListener</a> checkoutSignalListener)</code>
<div class="block">Sets an instance of a CheckoutSignalListener for all signals to allow
switched implementations.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#setSnippet-java.lang.String-">setSnippet</a></span>(java.lang.String snippet)</code>
<div class="block">Startup option for use when using a snippet obtained from server
Loads html checkout "snippet" received from server into
main WebView.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#setWebView-android.webkit.WebView-">setWebView</a></span>(android.webkit.WebView suppliedWebView)</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/klarna/checkout/KlarnaCheckout.html#suspend--">suspend</a></span>()</code>
<div class="block">Sends message to checkout to suspend operations.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KlarnaCheckout-android.app.Activity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KlarnaCheckout</h4>
<pre>public KlarnaCheckout(android.app.Activity currentActivity)</pre>
</li>
</ul>
<a name="KlarnaCheckout-android.app.Activity-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KlarnaCheckout</h4>
<pre>public KlarnaCheckout(android.app.Activity currentActivity,
java.lang.String redirectURI)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="suspend--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suspend</h4>
<pre>public void suspend()</pre>
<div class="block">Sends message to checkout to suspend operations.</div>
</li>
</ul>
<a name="resume--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre>public void resume()</pre>
<div class="block">Sends message to checkout to resume operations.</div>
</li>
</ul>
<a name="setWebView-android.webkit.WebView-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWebView</h4>
<pre>public void setWebView(android.webkit.WebView suppliedWebView)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>suppliedWebView</code> - </dd>
</dl>
</li>
</ul>
<a name="setSnippet-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSnippet</h4>
<pre>public void setSnippet(java.lang.String snippet)</pre>
<div class="block">Startup option for use when using a snippet obtained from server
Loads html checkout "snippet" received from server into
main WebView.
<p/>
NOTE: This is not needed if a supplied webview is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snippet</code> - the snippet of html code that initializes the checkout.</dd>
</dl>
</li>
</ul>
<a name="setGooglePushMessageToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGooglePushMessageToken</h4>
<pre>public static void setGooglePushMessageToken(java.lang.String token)</pre>
<div class="block">Sets google push messaging token if using with Klarna's GCM</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>token</code> - the token received from google.</dd>
</dl>
</li>
</ul>
<a name="getView--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getView</h4>
<pre>public android.view.View getView()</pre>
<div class="block">Returns the currentcheckout view} instance</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>instance of the main WebView being used by checkout.
but it is cast down to view only.</dd>
</dl>
</li>
</ul>
<a name="setSignalListener-com.klarna.checkout.SignalListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSignalListener</h4>
<pre>public void setSignalListener(<a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout">SignalListener</a> checkoutSignalListener)</pre>
<div class="block">Sets an instance of a CheckoutSignalListener for all signals to allow
switched implementations.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>checkoutSignalListener</code> - an SignalListener implemented instance.</dd>
</dl>
</li>
</ul>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroy</h4>
<pre>public void destroy()</pre>
<div class="block">Method to destroy checkout and remove all resources.
NOTE: the main WebView will only be destroyed if the
checkout has created it. In hybrid mode the WebView will
remain untouched.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/klarna/checkout/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../com/klarna/checkout/SignalListener.html" title="interface in com.klarna.checkout"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/klarna/checkout/KlarnaCheckout.html" target="_top">Frames</a></li>
<li><a href="KlarnaCheckout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>