ReCaptcha/Classes/ReCaptchaDecoder/Result.html

320 lines
14 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>Result Enumeration 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/Enum/Result" class="dashAnchor"></a>
<a title="Result Enumeration 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" />
Result Enumeration 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>Result</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">enum</span> <span class="kt">Result</span></code></pre>
</div>
</div>
<p>The decoder result.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO5tokenAESScAEmF"></a>
<a name="//apple_ref/swift/Element/token" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO5tokenAESScAEmF">token</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A result token, if any</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="nf">token</span><span class="p">(</span><span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO04showaB0A2EmF"></a>
<a name="//apple_ref/swift/Element/showReCaptcha" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO04showaB0A2EmF">showReCaptcha</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Indicates that the webview containing the challenge should be displayed.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">showReCaptcha</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO5errorAeA0aB5ErrorOcAEmF"></a>
<a name="//apple_ref/swift/Element/error" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO5errorAeA0aB5ErrorOcAEmF">error</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Any errors</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="nf">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>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO7didLoadA2EmF"></a>
<a name="//apple_ref/swift/Element/didLoad" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO7didLoadA2EmF">didLoad</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Did finish loading resources</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">didLoad</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO3logAESScAEmF"></a>
<a name="//apple_ref/swift/Element/log" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO3logAESScAEmF">log</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Logs a string onto the console</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="nf">log</span><span class="p">(</span><span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB7DecoderC6ResultO4from33_BFC5AA2DAB5901AE176B9DCF91FD1820LLAEs10DictionaryVySSypG8response_tFZ"></a>
<a name="//apple_ref/swift/Method/from(response:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB7DecoderC6ResultO4from33_BFC5AA2DAB5901AE176B9DCF91FD1820LLAEs10DictionaryVySSypG8response_tFZ">from(response:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parses a dict received from the webview onto a <code>ReCaptchaDecoder.Result</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">from</span><span class="p">(</span><span class="nv">response</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../../Classes/ReCaptchaDecoder.html">ReCaptchaDecoder</a></span><span class="o">.</span><span class="kt">Result</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>response</em>
</code>
</td>
<td>
<div>
<p>A dictionary containing the message to be parsed</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A decoded ReCaptchaDecoder.Result</p>
</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>