stripe-ios/stripe3ds2-support/doc/html/Protocols/STDSChallengeStatusReceiver...

413 lines
11 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>STDSChallengeStatusReceiver Protocol Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">Stripe3DS2 </a>
</h1>
<p id="developer-home">
<a href="../index.html">Stripe</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Instance Methods">
<option value="//api/name/transaction:didCompleteChallengeWithCompletionEvent:">- transaction:didCompleteChallengeWithCompletionEvent:</option>
<option value="//api/name/transaction:didErrorWithProtocolErrorEvent:">- transaction:didErrorWithProtocolErrorEvent:</option>
<option value="//api/name/transaction:didErrorWithRuntimeErrorEvent:">- transaction:didErrorWithRuntimeErrorEvent:</option>
<option value="//api/name/transactionDidCancel:">- transactionDidCancel:</option>
<option value="//api/name/transactionDidTimeOut:">- transactionDidTimeOut:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">STDSChallengeStatusReceiver Protocol Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Declared in</th>
<td>STDSChallengeStatusReceiver.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>Implement the <code>STDSChallengeStatusReceiver</code> protocol to receive challenge status notifications at the end of the challenge process.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/transaction:didCompleteChallengeWithCompletionEvent:" title="transaction:didCompleteChallengeWithCompletionEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/transaction:didCompleteChallengeWithCompletionEvent:">&ndash;&nbsp;transaction:didCompleteChallengeWithCompletionEvent:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Called when the challenge process is completed.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)transaction:(STDSTransaction *)<em>transaction</em> didCompleteChallengeWithCompletionEvent:(STDSCompletionEvent *)<em>completionEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>completionEvent</code></th>
<td><p>Information about the completion of the challenge process. @see <a href="../Classes/STDSCompletionEvent.html"><code>STDSCompletionEvent</code></a></p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Called when the challenge process is completed.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">STDSChallengeStatusReceiver.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/transactionDidCancel:" title="transactionDidCancel:"></a>
<h3 class="method-title"><code><a href="#//api/name/transactionDidCancel:">&ndash;&nbsp;transactionDidCancel:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Called when the user selects the option to cancel the transaction on the challenge screen.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)transactionDidCancel:(STDSTransaction *)<em>transaction</em></code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Called when the user selects the option to cancel the transaction on the challenge screen.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">STDSChallengeStatusReceiver.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/transactionDidTimeOut:" title="transactionDidTimeOut:"></a>
<h3 class="method-title"><code><a href="#//api/name/transactionDidTimeOut:">&ndash;&nbsp;transactionDidTimeOut:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Called when the challenge process reaches or exceeds the timeout interval that was passed to <code></code>STDSTransaction<code>.doChallenge</code></p>
</div>
<div class="method-subsection method-declaration"><code>- (void)transactionDidTimeOut:(STDSTransaction *)<em>transaction</em></code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Called when the challenge process reaches or exceeds the timeout interval that was passed to <code></code>STDSTransaction<code>.doChallenge</code></p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">STDSChallengeStatusReceiver.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/transaction:didErrorWithProtocolErrorEvent:" title="transaction:didErrorWithProtocolErrorEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/transaction:didErrorWithProtocolErrorEvent:">&ndash;&nbsp;transaction:didErrorWithProtocolErrorEvent:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Called when the 3DS SDK receives an EMV 3-D Secure protocol-defined error message from the ACS.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)transaction:(STDSTransaction *)<em>transaction</em> didErrorWithProtocolErrorEvent:(STDSProtocolErrorEvent *)<em>protocolErrorEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>protocolErrorEvent</code></th>
<td><p>The error code and details. @see <a href="../Classes/STDSProtocolErrorEvent.html"><code>STDSProtocolErrorEvent</code></a></p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Called when the 3DS SDK receives an EMV 3-D Secure protocol-defined error message from the ACS.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">STDSChallengeStatusReceiver.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/transaction:didErrorWithRuntimeErrorEvent:" title="transaction:didErrorWithRuntimeErrorEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/transaction:didErrorWithRuntimeErrorEvent:">&ndash;&nbsp;transaction:didErrorWithRuntimeErrorEvent:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Called when the 3DS SDK encounters errors during the challenge process. These errors include all errors except those covered by <code>didErrorWithProtocolErrorEvent</code>.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)transaction:(STDSTransaction *)<em>transaction</em> didErrorWithRuntimeErrorEvent:(STDSRuntimeErrorEvent *)<em>runtimeErrorEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>runtimeErrorEvent</code></th>
<td><p>The error code and details. @see <a href="../Classes/STDSRuntimeErrorEvent.html"><code>STDSRuntimeErrorEvent</code></a></p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Called when the 3DS SDK encounters errors during the challenge process. These errors include all errors except those covered by <code>didErrorWithProtocolErrorEvent</code>.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">STDSChallengeStatusReceiver.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2019 Stripe. All rights reserved. Updated: 2019-05-21</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>