erik/akismet-kotlin
erik/akismet-kotlin
1
1
Fork 0
Code Issues Pull requests Releases Activity

Updated docs

Browse source
This commit is contained in:
Erik C. Thauvin 2024-05-24 02:45:08 -07:00
parent c5810c1986
commit 156d85fee1
Signed by: erik
GPG key ID: 776702A6A2DA330E
104 changed files with 4271 additions and 181 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html
View file

@ -66,10 +66,10 @@
<div class="cover ">
<h1 class="cover"><span>verify</span><wbr></wbr><span><span>Key</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L239">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-verified-key.html"><span>Akismet.</span><wbr></wbr><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L239">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-verified-key.html"><span>Akismet.</span><wbr></wbr><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>