49 lines
6.5 KiB
HTML
49 lines
6.5 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>executeMethod</title>
|
|
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/executeMethod/#okhttp3.HttpUrl?#okhttp3.FormBody#kotlin.Boolean/PointingToDeclaration//769193423">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a>/<a href="../index.html">net.thauvin.erik.akismet</a>/<a href="index.html">Akismet</a>/<a href="execute-method.html">executeMethod</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>execute</span><wbr></wbr><span><span>Method</span></span></h1>
|
|
</div>
|
|
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a></div></div>fun <a href="execute-method.html">executeMethod</a>(apiUrl: <span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span>?, formBody: <span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span>, trueOnError: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<p class="paragraph">Executes a call to an Akismet REST API method.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>api</span><wbr></wbr><span><span>Url</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>form</span><wbr></wbr><span><span>Body</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Set to return <code>true</code> on error (IO, empty response, etc.)</p></div></div></div></div></div></div></div></div></div></div></div>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="-1071796517%2FSource%2F769193423" anchor-label="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L320" id="-1071796517%2FSource%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
|
|
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L320">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1071796517%2FSource%2F769193423"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|