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/execute-method.html
View file

@ -66,10 +66,10 @@
<div class="cover ">
<h1 class="cover"><span>execute</span><wbr></wbr><span><span>Method</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="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></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#L319">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</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><u><span>api</span><wbr></wbr><span><span>Url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div><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><u><span>form</span><wbr></wbr><span><span>Body</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div><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><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error (IO, empty response, etc.)</p></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="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></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#L319">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</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><u><span>api</span><wbr></wbr><span><span>Url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div><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><u><span>form</span><wbr></wbr><span><span>Body</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div><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><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error (IO, empty response, etc.)</p></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>