ReCaptcha/Classes/ReCaptchaWebViewManager/WebViewDelegate.html

418 lines
21 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>WebViewDelegate 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/WebViewDelegate" class="dashAnchor"></a>
<a title="WebViewDelegate 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" />
WebViewDelegate 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>WebViewDelegate</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="n">fileprivate</span> <span class="kd">class</span> <span class="kt">WebViewDelegate</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">WKNavigationDelegate</span></code></pre>
</div>
</div>
<p>The <code><a href="../../Classes/ReCaptchaWebViewManager.html#/s:9ReCaptcha0aB14WebViewManagerC03webD033_C3529EC2362FD51A816C2A521FEB1AA9LLSo05WKWebD0Cv">webView</a></code> delegate object that performs execution uppon script loading</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC9ConstantsV"></a>
<a name="//apple_ref/swift/Struct/Constants" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC9ConstantsV">Constants</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>
<a href="../../Classes/ReCaptchaWebViewManager/WebViewDelegate/Constants.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="n">fileprivate</span> <span class="kd">class</span> <span class="kt">WebViewDelegate</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">WKNavigationDelegate</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC7managerACSgXwv"></a>
<a name="//apple_ref/swift/Property/manager" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC7managerACSgXwv">manager</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The parent manager</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">private</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">manager</span><span class="p">:</span> <span class="kt"><a href="../../Classes/ReCaptchaWebViewManager.html">ReCaptchaWebViewManager</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC14activeRequestss3SetVySSGv"></a>
<a name="//apple_ref/swift/Property/activeRequests" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC14activeRequestss3SetVySSGv">activeRequests</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The active requests&rsquo; urls</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">activeRequests</span> <span class="o">=</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">minimumCapacity</span><span class="p">:</span> <span class="mi">0</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLCAfC7manager_tcfc"></a>
<a name="//apple_ref/swift/Method/init(manager:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLCAfC7manager_tcfc">init(manager:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">manager</span><span class="p">:</span> <span class="kt"><a href="../../Classes/ReCaptchaWebViewManager.html">ReCaptchaWebViewManager</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>manager</em>
</code>
</td>
<td>
<div>
<p>The parent manager</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC03webD0ySo05WKWebD0C_So18WKNavigationActionC15decidePolicyForySC0qrT0Oc15decisionHandlertF"></a>
<a name="//apple_ref/swift/Method/webView(_:decidePolicyFor:decisionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC03webD0ySo05WKWebD0C_So18WKNavigationActionC15decidePolicyForySC0qrT0Oc15decisionHandlertF">webView(_:decidePolicyFor:decisionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decides whether to allow or cancel a navigation.</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">webView</span><span class="p">(</span>
<span class="n">_</span> <span class="nv">webView</span><span class="p">:</span> <span class="kt">WKWebView</span><span class="p">,</span>
<span class="n">decidePolicyFor</span> <span class="nv">navigationAction</span><span class="p">:</span> <span class="kt">WKNavigationAction</span><span class="p">,</span>
<span class="nv">decisionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">WKNavigationActionPolicy</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>webView</em>
</code>
</td>
<td>
<div>
<p>The web view invoking the delegate method.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>navigationAction</em>
</code>
</td>
<td>
<div>
<p>Descriptive information about the action triggering the navigation request.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>decisionHandler</em>
</code>
</td>
<td>
<div>
<p>The decision handler to call to allow or cancel the navigation. The argument is one of
the constants of the enumerated type WKNavigationActionPolicy.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC03webD0ySo05WKWebD0C_So20WKNavigationResponseC15decidePolicyForySC0qrT0Oc15decisionHandlertF"></a>
<a name="//apple_ref/swift/Method/webView(_:decidePolicyFor:decisionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC03webD0ySo05WKWebD0C_So20WKNavigationResponseC15decidePolicyForySC0qrT0Oc15decisionHandlertF">webView(_:decidePolicyFor:decisionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decides whether to allow or cancel a navigation after its response is known.</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">webView</span><span class="p">(</span>
<span class="n">_</span> <span class="nv">webView</span><span class="p">:</span> <span class="kt">WKWebView</span><span class="p">,</span>
<span class="n">decidePolicyFor</span> <span class="nv">navigationResponse</span><span class="p">:</span> <span class="kt">WKNavigationResponse</span><span class="p">,</span>
<span class="nv">decisionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">WKNavigationResponsePolicy</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>webView</em>
</code>
</td>
<td>
<div>
<p>The web view invoking the delegate method.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>navigationResponse</em>
</code>
</td>
<td>
<div>
<p>Descriptive information about the navigation response.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>decisionHandler</em>
</code>
</td>
<td>
<div>
<p>A block to be called when your app has decided whether to allow or cancel the navigation</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC7executeyyF"></a>
<a name="//apple_ref/swift/Method/execute()" class="dashAnchor"></a>
<a class="token" href="#/s:9ReCaptcha0aB14WebViewManagerC0cD8Delegate33_C3529EC2362FD51A816C2A521FEB1AA9LLC7executeyyF">execute()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Flag the requests as finished and call ReCaptcha execution if necessary</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">execute</span><span class="p">()</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>