ReCaptcha/Classes/ReCaptchaDecoder.html

293 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>ReCaptchaDecoder Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/ReCaptchaDecoder" class="dashAnchor"></a>
<a title="ReCaptchaDecoder Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ReCaptcha Docs</a> (87% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ReCaptcha Reference</a>
<img id="carat" src="../img/carat.png" />
ReCaptchaDecoder Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/ReCaptcha.html">ReCaptcha</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptcha/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptcha/Endpoint.html"> Endpoint</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptcha/Config.html"> Config</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptchaDecoder.html">ReCaptchaDecoder</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptchaDecoder/Result.html"> Result</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptchaWebViewManager.html">ReCaptchaWebViewManager</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptchaWebViewManager/WebViewDelegate.html"> WebViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ReCaptchaWebViewManager/Constants.html"> Constants</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/ReCaptchaError.html">ReCaptchaError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Reactive.html">Reactive</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/String.html">String</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>ReCaptchaDecoder</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">internal</span> <span class="kd">class</span> <span class="kt">ReCaptchaDecoder</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>The Decoder of javascript messages from the webview</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO"></a>
<a name="//apple_ref/swift/Enum/Result" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO">Result</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The decoder result.</p>
<a href="../Classes/ReCaptchaDecoder/Result.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">enum</span> <span class="kt">Result</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC11sendMessage33_BFC5AA2DAB5901AE176B9DCF91FD1820LLyAC6ResultOcv"></a>
<a name="//apple_ref/swift/Property/sendMessage" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC11sendMessage33_BFC5AA2DAB5901AE176B9DCF91FD1820LLyAC6ResultOcv">sendMessage</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The closure that receives messages</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="n">fileprivate</span> <span class="k">let</span> <span class="nv">sendMessage</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Classes/ReCaptchaDecoder/Result.html">Result</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderCACyAC6ResultOc17didReceiveMessage_tcfc"></a>
<a name="//apple_ref/swift/Method/init(didReceiveMessage:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderCACyAC6ResultOc17didReceiveMessage_tcfc">init(didReceiveMessage:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initializes a decoder with a completion closure.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">didReceiveMessage</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/ReCaptchaDecoder/Result.html">Result</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>didReceiveMessage</em>
</code>
</td>
<td>
<div>
<p>A closure that receives a ReCaptchaDecoder.Result</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC4sendyAA0aB5ErrorO5error_tF"></a>
<a name="//apple_ref/swift/Method/send(error:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC4sendyAA0aB5ErrorO5error_tF">send(error:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sends an error to the completion closure</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../Enums/ReCaptchaError.html">ReCaptchaError</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>error</em>
</code>
</td>
<td>
<div>
<p>The error to be sent.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:@CM@ReCaptcha@objc(cs)ReCaptchaDecoder(im)userContentController:didReceiveScriptMessage:"></a>
<a name="//apple_ref/swift/Method/userContentController(_:didReceive:)" class="dashAnchor"></a>
<a class="token" href="#/c:@CM@ReCaptcha@objc(cs)ReCaptchaDecoder(im)userContentController:didReceiveScriptMessage:">userContentController(_:didReceive:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">internal</span> <span class="kd">class</span> <span class="kt">ReCaptchaDecoder</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/fjcaetano/ReCaptcha" target="_blank" rel="external">Flávio Caetano</a>. All rights reserved. (Last updated: 2018-03-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>