198 lines
8.7 KiB
HTML
198 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>Reactive Extension 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/Extension/Reactive" class="dashAnchor"></a>
|
||
<a title="Reactive Extension Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="../index.html">ReCaptcha Docs</a> (100% documented)</p>
|
||
<p class="header-right"><a href="https://github.com/fjcaetano/ReCaptcha"><img src="../img/gh.png"/>View on GitHub</a></p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="../index.html">ReCaptcha Reference</a>
|
||
<img id="carat" src="../img/carat.png" />
|
||
Reactive Extension 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/Endpoint.html">– Endpoint</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>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/ReCaptchaResult.html">ReCaptchaResult</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/Reactive.html">Reactive</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
<h1>Reactive</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight"><code><span class="kd">struct</span> <span class="kt">Reactive</span><span class="o"><</span><span class="kt">Base</span><span class="o">></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>Provides a public extension on ReCaptcha that makes it reactive.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:7RxSwift8ReactiveV9ReCaptchaA2DCRbzlE8validate2on12resetOnErrorAA10ObservableCySSGSo6UIViewC_SbtF"></a>
|
||
<a name="//apple_ref/swift/Method/validate(on:resetOnError:)" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:7RxSwift8ReactiveV9ReCaptchaA2DCRbzlE8validate2on12resetOnErrorAA10ObservableCySSGSo6UIViewC_SbtF">validate(on:resetOnError:)</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Starts the challenge validation uppon subscription.</p>
|
||
|
||
<p>The stream’s element is a String with the validation token.</p>
|
||
|
||
<p>Sends <code>stop()</code> uppon disposal.</p>
|
||
<div class="aside aside-see">
|
||
<p class="aside-title">See</p>
|
||
<code><a href="../Classes/ReCaptcha.html#/s:9ReCaptchaAAC8validate2on12resetOnError10completionySo6UIViewC_SbyAA0aB6ResultOctF">ReCaptcha.validate(on:resetOnError:completion:)</a></code>
|
||
|
||
</div>
|
||
<div class="aside aside-see">
|
||
<p class="aside-title">See</p>
|
||
<code><a href="../Classes/ReCaptcha.html#/s:9ReCaptchaAAC4stopyyF">ReCaptcha.stop()</a></code>
|
||
|
||
</div>
|
||
|
||
</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">validate</span><span class="p">(</span><span class="n">on</span> <span class="nv">view</span><span class="p">:</span> <span class="kt">UIView</span><span class="p">,</span> <span class="nv">resetOnError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Observable</span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<h4>Parameters</h4>
|
||
<table class="graybox">
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>view</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>The view that should present the webview.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>resetOnError</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>If ReCaptcha should be reset if it errors. Defaults to <code>true</code></p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:7RxSwift8ReactiveV9ReCaptchaA2DCRbzlE5resetAA11AnyObserverVyytGvp"></a>
|
||
<a name="//apple_ref/swift/Property/reset" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:7RxSwift8ReactiveV9ReCaptchaA2DCRbzlE5resetAA11AnyObserverVyytGvp">reset</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Resets the ReCaptcha.</p>
|
||
|
||
<p>The reset is achieved by calling <code>grecaptcha.reset()</code> on the JS API.</p>
|
||
<div class="aside aside-see">
|
||
<p class="aside-title">See</p>
|
||
<code><a href="../Classes/ReCaptcha.html#/s:9ReCaptchaAAC5resetyyF">ReCaptcha.reset()</a></code>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight"><code><span class="k">var</span> <span class="nv">reset</span><span class="p">:</span> <span class="kt">AnyObserver</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 2018 <a class="link" href="https://github.com/fjcaetano" target="_blank" rel="external">Flávio Caetano (@fjcaetano)</a>. All rights reserved. (Last updated: 2018-09-28)</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>
|