Fixed docs generation classpath
This commit is contained in:
parent
d3cabe5e83
commit
56a8cbd7f7
GPG key ID:
776702A6A2DA330E
133 changed files with 10152 additions and 57 deletions
80
docs/root/net.thauvin.erik.akismet/-akismet/-akismet.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/-akismet.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>Akismet</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/Akismet/#kotlin.String#kotlin.String/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Akismet</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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>dateToGmt</title>
|
||||
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet.Companion/dateToGmt/#java.util.Date/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../../index.html">root</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">dateToGmt</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>date</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Gmt</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">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html">Date</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p><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="../../-akismet-comment/date-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>dateGmt</span></a></div></span></div><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><a href="../../-akismet-comment/post-modified-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/LocalDateTime.html">LocalDateTime</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p><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="../../-akismet-comment/date-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>dateGmt</span></a></div></span></div><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><a href="../../-akismet-comment/post-modified-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>Companion</title>
|
||||
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="classlike" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet.Companion///PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../../index.html">root</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><span class="current">Companion</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Companion</span></span></h1>
|
||||
<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">object </span><a href="index.html">Companion</a></div></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="1844418243%2FFunctions%2F-1617659094" anchor-label="dateToGmt" id="1844418243%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="date-to-gmt.html"><span>date</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Gmt</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1844418243%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/LocalDateTime.html">LocalDateTime</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p></div><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html">Date</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1924768251%2FFunctions%2F-1617659094" anchor-label="jsonComment" id="1924768251%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="json-comment.html"><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1924768251%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a></div><div class="brief "><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p></div></div></div>
|
||||
</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>jsonComment</title>
|
||||
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet.Companion/jsonComment/#kotlin.String/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../../index.html">root</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">jsonComment</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>json</span><wbr></wbr><span><span>Comment</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">fun </span><a href="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a></div><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p><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="../../-akismet-comment/to-string.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>toString</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>appUserAgent</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/appUserAgent/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">appUserAgent</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>app</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Agent</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">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The application user agent to be sent to Akismet.</p><p class="paragraph">If possible, the application user agent string should always use the following format:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea"> Application Name/Version</code></pre><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><p class="paragraph">The library's own user agent string will automatically be appended.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#detailed-docs">Akismet API</a> for more details.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/blog.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/blog.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>blog</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/blog/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">blog</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>blog</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">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The URL registered with Akismet.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>checkComment</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/checkComment/#net.thauvin.erik.akismet.AkismetComment#kotlin.Boolean/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">checkComment</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>check</span><wbr></wbr><span><span>Comment</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">fun </span><a href="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><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></div><p class="paragraph">Comment Check.</p><p class="paragraph">This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data</p><p class="paragraph">By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return <code class="lang-kotlin">false</code> and log the error, use the <code class="lang-kotlin">trueOnError</code> parameter to change this behavior.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">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 comment is spam, <code class="lang-kotlin">false</code> if the comment is not.</p></span><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>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.</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/debug-help.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/debug-help.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>debugHelp</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/debugHelp/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">debugHelp</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>debug</span><wbr></wbr><span><span>Help</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">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p><p class="paragraph">If the call returns neither <code class="lang-kotlin">true</code> nor <code class="lang-kotlin">false</code>, the <code class="lang-kotlin">x-akismet-debug-help</code> header will provide context for any error that has occurred.</p><p class="paragraph">Note that the <code class="lang-kotlin">x-akismet-debug-help</code> header will not always be sent if a response does not return <code class="lang-kotlin">false</code> or <code class="lang-kotlin">true</code>.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>errorMessage</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/errorMessage/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">errorMessage</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>error</span><wbr></wbr><span><span>Message</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">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The error message.</p><p class="paragraph">The error (IO, empty response from Akismet, etc.) message is also logged as a warning.</p><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="check-comment.html"><span>Akismet.</span><wbr></wbr><span>check</span><wbr></wbr><span><span>Comment</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<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>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/executeMethod/#[Error type: Unresolved type for HttpUrl]#[Error type: Unresolved type for FormBody]#kotlin.Boolean/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">executeMethod</span></div>
|
||||
<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">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="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></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></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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>httpStatusCode</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/httpStatusCode/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">httpStatusCode</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>http</span><wbr></wbr><span>Status</span><wbr></wbr><span><span>Code</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">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
371
docs/root/net.thauvin.erik.akismet/-akismet/index.html
Normal file
371
docs/root/net.thauvin.erik.akismet/-akismet/index.html
Normal file
|
|
@ -0,0 +1,371 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>Akismet</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="classlike" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet///PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Akismet</span></span></h1>
|
||||
<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">open </span><span class="token keyword">class </span><a href="index.html">Akismet</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<div data-togglable="CONSTRUCTOR">
|
||||
<h2 class="">Constructors</h2>
|
||||
<div class="table"><a data-name="708515701%2FConstructors%2F-1617659094" anchor-label="Akismet" id="708515701%2FConstructors%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current="root/main" data-filterable-set="root/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="-akismet.html"><span><span>Akismet</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="708515701%2FConstructors%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="TYPE">
|
||||
<h2 class="">Types</h2>
|
||||
<div class="table"><a data-name="-619578907%2FClasslikes%2F-1617659094" anchor-label="Companion" id="-619578907%2FClasslikes%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="-companion/index.html"><span><span>Companion</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-619578907%2FClasslikes%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">object </span><a href="-companion/index.html">Companion</a></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="PROPERTY">
|
||||
<h2 class="">Properties</h2>
|
||||
<div class="table"><a data-name="140563587%2FProperties%2F-1617659094" anchor-label="appUserAgent" id="140563587%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="app-user-agent.html"><span>app</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Agent</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="140563587%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The application user agent to be sent to Akismet.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1491328806%2FProperties%2F-1617659094" anchor-label="blog" id="-1491328806%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="blog.html"><span><span>blog</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1491328806%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The URL registered with Akismet.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1839698666%2FProperties%2F-1617659094" anchor-label="debugHelp" id="1839698666%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="debug-help.html"><span>debug</span><wbr></wbr><span><span>Help</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1839698666%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1854217411%2FProperties%2F-1617659094" anchor-label="errorMessage" id="-1854217411%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="error-message.html"><span>error</span><wbr></wbr><span><span>Message</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1854217411%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The error message.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1217730997%2FProperties%2F-1617659094" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="http-status-code.html"><span>http</span><wbr></wbr><span>Status</span><wbr></wbr><span><span>Code</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1217730997%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1920554762%2FProperties%2F-1617659094" anchor-label="isDiscard" id="1920554762%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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-discard.html"><span>is</span><wbr></wbr><span><span>Discard</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1920554762%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="2050471377%2FProperties%2F-1617659094" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2050471377%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1616027372%2FProperties%2F-1617659094" anchor-label="logger" id="1616027372%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="logger.html"><span><span>logger</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1616027372%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a></div><div class="brief "><p class="paragraph">The logger instance.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="42530702%2FProperties%2F-1617659094" anchor-label="proTip" id="42530702%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="pro-tip.html"><span>pro</span><wbr></wbr><span><span>Tip</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="42530702%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1549072997%2FProperties%2F-1617659094" anchor-label="response" id="-1549072997%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="response.html"><span><span>response</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1549072997%2FProperties%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The actual response sent by Akismet from the last operation.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="158460567%2FFunctions%2F-1617659094" anchor-label="checkComment" id="158460567%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="check-comment.html"><span>check</span><wbr></wbr><span><span>Comment</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="158460567%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><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></div><div class="brief "><p class="paragraph">Comment Check.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-385392482%2FFunctions%2F-1617659094" anchor-label="executeMethod" id="-385392482%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="execute-method.html"><span>execute</span><wbr></wbr><span><span>Method</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-385392482%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></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></div><div class="brief "><p class="paragraph">Executes a call to an Akismet REST API method.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-707138897%2FFunctions%2F-1617659094" anchor-label="reset" id="-707138897%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="reset.html"><span><span>reset</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-707138897%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1211675440%2FFunctions%2F-1617659094" anchor-label="submitHam" id="-1211675440%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="submit-ham.html"><span>submit</span><wbr></wbr><span><span>Ham</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1211675440%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></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></div><div class="brief "><p class="paragraph">Submit Ham. (False Positives)</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-578133801%2FFunctions%2F-1617659094" anchor-label="submitSpam" id="-578133801%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="submit-spam.html"><span>submit</span><wbr></wbr><span><span>Spam</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-578133801%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></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></div><div class="brief "><p class="paragraph">Submit Spam. (Missed Spam)</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="869122104%2FFunctions%2F-1617659094" anchor-label="verifyKey" id="869122104%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<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="verify-key.html"><span>verify</span><wbr></wbr><span><span>Key</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="869122104%2FFunctions%2F-1617659094"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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></div><div class="brief "><p class="paragraph">Key Verification.</p></div></div></div>
|
||||
</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/is-discard.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/is-discard.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>isDiscard</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/isDiscard/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isDiscard</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>is</span><wbr></wbr><span><span>Discard</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">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><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="pro-tip.html"><span>Akismet.</span><wbr></wbr><span>proTip</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>isVerifiedKey</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/isVerifiedKey/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isVerifiedKey</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>is</span><wbr></wbr><span>Verified</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">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p><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="verify-key.html"><span>Akismet.</span><wbr></wbr><span>verifyKey</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/logger.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/logger.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>logger</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/logger/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">logger</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>logger</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">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a></div><p class="paragraph">The logger instance.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/pro-tip.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/pro-tip.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>proTip</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/proTip/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">proTip</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>pro</span><wbr></wbr><span><span>Tip</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">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p><p class="paragraph">If the <code class="lang-kotlin">x-akismet-pro-tip</code> header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><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-discard.html"><span>Akismet.</span><wbr></wbr><span>isDiscard</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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/reset.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/reset.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>reset</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/reset/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">reset</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>reset</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">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/response.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/response.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>response</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/response/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">response</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>response</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">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The actual response sent by Akismet from the last operation.</p><p class="paragraph">For example: <code class="lang-kotlin">true</code>, <code class="lang-kotlin">false</code>, <code class="lang-kotlin">valid</code>, <code class="lang-kotlin">invalid</code>, etc.</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/submit-ham.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/submit-ham.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>submitHam</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/submitHam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitHam</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>submit</span><wbr></wbr><span><span>Ham</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">fun </span><a href="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></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></div><p class="paragraph">Submit Ham. (False Positives)</p><p class="paragraph">This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as <a href="check-comment.html">comment check</a> and <a href="submit-spam.html">submit spam</a>.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-ham">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 comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/submit-spam.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/submit-spam.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>submitSpam</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitSpam</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>submit</span><wbr></wbr><span><span>Spam</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">fun </span><a href="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></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></div><p class="paragraph">Submit Spam. (Missed Spam)</p><p class="paragraph">This call is for submitting comments that weren't marked as spam but should have been.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-spam">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 comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
80
docs/root/net.thauvin.erik.akismet/-akismet/verify-key.html
Normal file
80
docs/root/net.thauvin.erik.akismet/-akismet/verify-key.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="no-js">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>verifyKey</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
<script>document.documentElement.classList.replace("no-js","js");</script>
|
||||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||||
if (storage == null) {
|
||||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||||
if (osDarkSchemePreferred === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
} else {
|
||||
const savedDarkMode = JSON.parse(storage)
|
||||
if(savedDarkMode === true) {
|
||||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||||
<link href="../../../styles/font-jb-sans-auto.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" defer="defer"></script>
|
||||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="root">
|
||||
<nav class="navigation" id="navigation-wrapper">
|
||||
<div class="navigation--inner">
|
||||
<div class="navigation-title">
|
||||
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
||||
<div class="library-name">
|
||||
<a class="library-name--link" href="../../../index.html">
|
||||
root
|
||||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
</div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="navigation-controls">
|
||||
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
||||
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="container">
|
||||
<div class="sidebar" id="leftColumn">
|
||||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="root::net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">root</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">verifyKey</span></div>
|
||||
<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">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></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>© 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue