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

Cleanup before 1.0 release

Browse source
This commit is contained in:
Erik C. Thauvin 2023-09-24 18:09:24 -07:00
parent e89074b986
commit 900371cc83
74 changed files with 3309 additions and 2415 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,5 +1,7 @@
[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.10-7f52ff)](https://kotlinlang.org/)
[![Release](https://img.shields.io/github/release/ethauvin/akismet-kotlin.svg)](https://github.com/ethauvin/akismet-kotlin/releases/latest)
[![Nexus Snapshot](https://img.shields.io/nexus/s/net.thauvin.erik/akismet-kotlin?label=snapshot&server=https%3A%2F%2Foss.sonatype.org%2F)](https://oss.sonatype.org/content/repositories/snapshots/net/thauvin/erik/akismet-kotlin/)
[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/akismet-kotlin.svg?color=blue)](https://central.sonatype.com/artifact/net.thauvin.erik/akismet-kotlin)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_akismet-kotlin&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_akismet-kotlin)
@ -70,7 +72,7 @@ repositories {
}
dependencies {
implementation("net.thauvin.erik:akismet-kotlin:0.9.3")
implementation("net.thauvin.erik:akismet-kotlin:1.0.0")
}
```

5
build.gradle.kts
View file

@ -59,6 +59,7 @@ dependencies {
implementation("com.squareup.okhttp3:okhttp:${Versions.OKHTTP}")
implementation("com.squareup.okio:okio:3.5.0")
implementation("com.squareup.okhttp3:logging-interceptor:${Versions.OKHTTP}")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.0")
@ -189,7 +190,7 @@ tasks {
register("deploy") {
description = "Copies all needed files to the $deployDir directory."
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(clean, wrapper, build, jar)
dependsOn(clean, build, jar)
outputs.dir(deployDir)
inputs.files(copyToDeploy)
mustRunAfter(clean)
@ -213,7 +214,7 @@ tasks {
register("release") {
description = "Publishes version ${project.version} to local repository."
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(wrapper, "deploy", gitTag, publishToMavenLocal)
dependsOn(dokkaHtml, "deploy", gitTag, publishToMavenLocal)
}
}

1
config/dokka/packages.md
View file

@ -6,4 +6,3 @@
A Kotlin/Java library for accessing the Akismet service.

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>AkismetComment</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/AkismetComment/#jakarta.servlet.http.HttpServletRequest/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/AkismetComment/#jakarta.servlet.http.HttpServletRequest/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">AkismetComment</span></div>
<div class="cover ">
<h1 class="cover"><span>Akismet</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet-comment.html"><span class="token function">AkismetComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L231">source</a>)</span></span></div><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><a href="server-env.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>serverEnv</span></a></div></span></div><div></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet-comment.html"><span class="token function">AkismetComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<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 ">userAgent<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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><p class="paragraph">Creates a new instance.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L231">source</a>)</span></span></div><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="server-env.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>serverEnv</span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<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 ">userAgent<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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><p class="paragraph">Creates a new instance.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>ADMIN_ROLE</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/ADMIN_ROLE/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/ADMIN_ROLE/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">ADMIN_ROLE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>ADMIN_ROLE</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L93">source</a>)</span></span></div><p class="paragraph">Administrator role. If used, Akismet will always return false.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L94">source</a>)</span></span></div><p class="paragraph">Administrator role. If used, Akismet will always return false.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_BLOG_POST</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_BLOG_POST/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_BLOG_POST/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_BLOG_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_BLOG_POST</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L72">source</a>)</span></span></div><p class="paragraph">A blog post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L73">source</a>)</span></span></div><p class="paragraph">A blog post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_COMMENT</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_COMMENT/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_COMMENT/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_COMMENT</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L63">source</a>)</span></span></div><p class="paragraph">A blog comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L64">source</a>)</span></span></div><p class="paragraph">A blog comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_CONTACT_FORM</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_CONTACT_FORM/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_CONTACT_FORM/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_CONTACT_FORM</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_CONTACT_FORM</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L75">source</a>)</span></span></div><p class="paragraph">A contact form or feedback form submission.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L76">source</a>)</span></span></div><p class="paragraph">A contact form or feedback form submission.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_FORUM_POST</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_FORUM_POST/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_FORUM_POST/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_FORUM_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_FORUM_POST</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L66">source</a>)</span></span></div><p class="paragraph">A top-level forum post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L67">source</a>)</span></span></div><p class="paragraph">A top-level forum post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_MESSAGE</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_MESSAGE/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_MESSAGE/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_MESSAGE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L81">source</a>)</span></span></div><p class="paragraph">A message sent between just a few users.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L82">source</a>)</span></span></div><p class="paragraph">A message sent between just a few users.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_PINGBACK</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_PINGBACK/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_PINGBACK/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_PINGBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_PINGBACK</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L84">source</a>)</span></span></div><p class="paragraph">A pingback.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L85">source</a>)</span></span></div><p class="paragraph">A pingback.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_REPLY</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_REPLY/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_REPLY/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_REPLY</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_REPLY</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L69">source</a>)</span></span></div><p class="paragraph">A reply to a top-level forum post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L70">source</a>)</span></span></div><p class="paragraph">A reply to a top-level forum post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_SIGNUP</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_SIGNUP/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_SIGNUP/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_SIGNUP</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_SIGNUP</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L78">source</a>)</span></span></div><p class="paragraph">A new user account.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L79">source</a>)</span></span></div><p class="paragraph">A new user account.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_TRACKBACK</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TRACKBACK/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TRACKBACK/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TRACKBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_TRACKBACK</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L87">source</a>)</span></span></div><p class="paragraph">A trackback.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L88">source</a>)</span></span></div><p class="paragraph">A trackback.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TYPE_TWEET</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TWEET</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_TWEET</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L90">source</a>)</span></span></div><p class="paragraph">A Twitter message.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L91">source</a>)</span></span></div><p class="paragraph">A Twitter message.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

279
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,196 +34,206 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion///PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L61">source</a>)</span></span></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Properties">Properties</button></div>
<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">
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="-1816802345%2FProperties%2F769193423" anchor-label="ADMIN_ROLE" id="-1816802345%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-d-m-i-n_-r-o-l-e.html"><span><span>ADMIN_ROLE</span></span></a></div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1816802345%2FProperties%2F769193423" anchor-label="ADMIN_ROLE" id="-1816802345%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-d-m-i-n_-r-o-l-e.html"><span><span>ADMIN_ROLE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1816802345%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1816802345%2FProperties%2F769193423" anchor-label="ADMIN_ROLE" id="-1816802345%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</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 "><a data-name="-1816802345%2FProperties%2F769193423" anchor-label="ADMIN_ROLE" id="-1816802345%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">Administrator role. If used, Akismet will always return false.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</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">Administrator role. If used, Akismet will always return false.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="40828741%2FProperties%2F769193423" anchor-label="TYPE_BLOG_POST" id="40828741%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html"><span><span>TYPE_BLOG_POST</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html"><span><span>TYPE_BLOG_POST</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="40828741%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="40828741%2FProperties%2F769193423" anchor-label="TYPE_BLOG_POST" id="40828741%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</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 "><a data-name="40828741%2FProperties%2F769193423" anchor-label="TYPE_BLOG_POST" id="40828741%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A blog post.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</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">A blog post.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1153876899%2FProperties%2F769193423" anchor-label="TYPE_COMMENT" id="1153876899%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-c-o-m-m-e-n-t.html"><span><span>TYPE_COMMENT</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-c-o-m-m-e-n-t.html"><span><span>TYPE_COMMENT</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1153876899%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1153876899%2FProperties%2F769193423" anchor-label="TYPE_COMMENT" id="1153876899%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</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 "><a data-name="1153876899%2FProperties%2F769193423" anchor-label="TYPE_COMMENT" id="1153876899%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A blog comment.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</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">A blog comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1929822549%2FProperties%2F769193423" anchor-label="TYPE_CONTACT_FORM" id="1929822549%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html"><span><span>TYPE_CONTACT_FORM</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html"><span><span>TYPE_CONTACT_FORM</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1929822549%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1929822549%2FProperties%2F769193423" anchor-label="TYPE_CONTACT_FORM" id="1929822549%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</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 "><a data-name="1929822549%2FProperties%2F769193423" anchor-label="TYPE_CONTACT_FORM" id="1929822549%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A contact form or feedback form submission.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</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">A contact form or feedback form submission.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1826794746%2FProperties%2F769193423" anchor-label="TYPE_FORUM_POST" id="1826794746%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html"><span><span>TYPE_FORUM_POST</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html"><span><span>TYPE_FORUM_POST</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1826794746%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1826794746%2FProperties%2F769193423" anchor-label="TYPE_FORUM_POST" id="1826794746%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</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 "><a data-name="1826794746%2FProperties%2F769193423" anchor-label="TYPE_FORUM_POST" id="1826794746%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A top-level forum post.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</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">A top-level forum post.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1363500795%2FProperties%2F769193423" anchor-label="TYPE_MESSAGE" id="1363500795%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-m-e-s-s-a-g-e.html"><span><span>TYPE_MESSAGE</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-m-e-s-s-a-g-e.html"><span><span>TYPE_MESSAGE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1363500795%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1363500795%2FProperties%2F769193423" anchor-label="TYPE_MESSAGE" id="1363500795%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</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 "><a data-name="1363500795%2FProperties%2F769193423" anchor-label="TYPE_MESSAGE" id="1363500795%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A message sent between just a few users.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</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">A message sent between just a few users.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="641236959%2FProperties%2F769193423" anchor-label="TYPE_PINGBACK" id="641236959%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html"><span><span>TYPE_PINGBACK</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html"><span><span>TYPE_PINGBACK</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="641236959%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="641236959%2FProperties%2F769193423" anchor-label="TYPE_PINGBACK" id="641236959%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</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 "><a data-name="641236959%2FProperties%2F769193423" anchor-label="TYPE_PINGBACK" id="641236959%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A pingback.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</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">A pingback.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-375729480%2FProperties%2F769193423" anchor-label="TYPE_REPLY" id="-375729480%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-r-e-p-l-y.html"><span><span>TYPE_REPLY</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-r-e-p-l-y.html"><span><span>TYPE_REPLY</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-375729480%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-375729480%2FProperties%2F769193423" anchor-label="TYPE_REPLY" id="-375729480%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</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 "><a data-name="-375729480%2FProperties%2F769193423" anchor-label="TYPE_REPLY" id="-375729480%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A reply to a top-level forum post.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</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">A reply to a top-level forum post.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="110004160%2FProperties%2F769193423" anchor-label="TYPE_SIGNUP" id="110004160%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-s-i-g-n-u-p.html"><span><span>TYPE_SIGNUP</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-s-i-g-n-u-p.html"><span><span>TYPE_SIGNUP</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="110004160%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="110004160%2FProperties%2F769193423" anchor-label="TYPE_SIGNUP" id="110004160%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</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 "><a data-name="110004160%2FProperties%2F769193423" anchor-label="TYPE_SIGNUP" id="110004160%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A new user account.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</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">A new user account.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1517505392%2FProperties%2F769193423" anchor-label="TYPE_TRACKBACK" id="1517505392%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html"><span><span>TYPE_TRACKBACK</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html"><span><span>TYPE_TRACKBACK</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1517505392%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1517505392%2FProperties%2F769193423" anchor-label="TYPE_TRACKBACK" id="1517505392%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</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 "><a data-name="1517505392%2FProperties%2F769193423" anchor-label="TYPE_TRACKBACK" id="1517505392%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A trackback.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</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">A trackback.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-551496431%2FProperties%2F769193423" anchor-label="TYPE_TWEET" id="-551496431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-t-w-e-e-t.html"><span><span>TYPE_TWEET</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-y-p-e_-t-w-e-e-t.html"><span><span>TYPE_TWEET</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-551496431%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-551496431%2FProperties%2F769193423" anchor-label="TYPE_TWEET" id="-551496431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</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 "><a data-name="-551496431%2FProperties%2F769193423" anchor-label="TYPE_TWEET" id="-551496431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A Twitter message.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</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">A Twitter message.</p></div></div></div>
</div>
</div>
</div>
</div>
@ -235,7 +247,8 @@
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>authorEmail</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorEmail/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorEmail/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorEmail</span></div>
<div class="cover ">
<h1 class="cover"><span>author</span><wbr></wbr><span><span>Email</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L138">source</a>)</span></span></div><p class="paragraph">Email address submitted with the comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L139">source</a>)</span></span></div><p class="paragraph">Email address submitted with the comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>authorUrl</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorUrl/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorUrl/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorUrl</span></div>
<div class="cover ">
<h1 class="cover"><span>author</span><wbr></wbr><span><span>Url</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L144">source</a>)</span></span></div><p class="paragraph">URL submitted with comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L145">source</a>)</span></span></div><p class="paragraph">URL submitted with comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>author</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/author/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/author/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">author</span></div>
<div class="cover ">
<h1 class="cover"><span><span>author</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L132">source</a>)</span></span></div><p class="paragraph">Name submitted with the comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L133">source</a>)</span></span></div><p class="paragraph">Name submitted with the comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>blogCharset</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogCharset/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogCharset/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogCharset</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Charset</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L188">source</a>)</span></span></div><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L191">source</a>)</span></span></div><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>blogLang</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogLang/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogLang/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogLang</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Lang</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L178">source</a>)</span></span></div><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p><p class="paragraph">A site with articles in English and French might use: <code class="lang-kotlin">en, fr_ca</code></p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L183">source</a>)</span></span></div><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p><p class="paragraph">A site with articles in English and French might use: <code class="lang-kotlin">en, fr_ca</code></p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>content</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/content/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/content/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">content</span></div>
<div class="cover ">
<h1 class="cover"><span><span>content</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L150">source</a>)</span></span></div><p class="paragraph">The content that was submitted.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L151">source</a>)</span></span></div><p class="paragraph">The content that was submitted.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dateGmt</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/dateGmt/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/dateGmt/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">dateGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>date</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L156">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p><p class="paragraph">May be omitted if the comment is sent to the API at the time it is created.</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L163">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p><p class="paragraph">May be omitted if the comment is sent to the API at the time it is created.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>equals</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/equals/#kotlin.Any?/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/equals/#kotlin.Any?/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">equals</span></div>
<div class="cover ">
<h1 class="cover"><span><span>equals</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L266">source</a>)</span></span></div><p class="paragraph">Indicates whether some other object is <i>equal to</i> this one.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L270">source</a>)</span></span></div><p class="paragraph">Indicates whether some other object is <i>equal to</i> this one.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>hashCode</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/hashCode/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/hashCode/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">hashCode</span></div>
<div class="cover ">
<h1 class="cover"><span>hash</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</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/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L297">source</a>)</span></span></div><p class="paragraph">Returns a hash code value for the object.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</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/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L301">source</a>)</span></span></div><p class="paragraph">Returns a hash code value for the object.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

598
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>AkismetComment</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,401 +34,398 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment///PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><span class="current">AkismetComment</span></div>
<div class="cover ">
<h1 class="cover"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">AkismetComment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>userIp<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 "><span class="token keyword">val </span>userAgent<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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L43">source</a>)</span></span></div><p class="paragraph">A comment to send to Akismet.</p><p class="paragraph">Most everything is optional. 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">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">AkismetComment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>userIp<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 "><span class="token keyword">val </span>userAgent<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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><p class="paragraph">A comment to send to Akismet.</p><p class="paragraph">Most everything is optional. 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">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Parameters">Parameters</button></div>
<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">
<h4 class="">Parameters</h4>
<div data-togglable="Parameters">
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div></div></div>
</div>
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="1820756519%2FConstructors%2F769193423" anchor-label="AkismetComment" id="1820756519%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1820756519%2FConstructors%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet-comment.html"><span class="token function">AkismetComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="117487489%2FConstructors%2F769193423" anchor-label="AkismetComment" id="117487489%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="117487489%2FConstructors%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet-comment.html"><span class="token function">AkismetComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<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 ">userAgent<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.</p></div></div></div>
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-589332580%2FConstructors%2F769193423" anchor-label="AkismetComment" id="-589332580%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-589332580%2FConstructors%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</p></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<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 ">userAgent<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.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="598470178%2FClasslikes%2F769193423" anchor-label="Companion" id="598470178%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="598470178%2FClasslikes%2F769193423" anchor-label="Companion" id="598470178%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="598470178%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
<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=":dokkaHtml/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>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1602627458%2FFunctions%2F769193423" anchor-label="equals" id="1602627458%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="equals.html"><span><span>equals</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1602627458%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</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">Indicates whether some other object is <i>equal to</i> this one.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1389700900%2FFunctions%2F769193423" anchor-label="hashCode" id="1389700900%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="hash-code.html"><span>hash</span><wbr></wbr><span><span>Code</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1389700900%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</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/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Returns a hash code value for the object.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="662793916%2FFunctions%2F769193423" anchor-label="toJson" id="662793916%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-json.html"><span>to</span><wbr></wbr><span><span>Json</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="662793916%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</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/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1211534835%2FFunctions%2F769193423" anchor-label="toString" id="1211534835%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-string.html"><span>to</span><wbr></wbr><span><span>String</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1211534835%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</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/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="332140596%2FProperties%2F769193423" anchor-label="author" id="332140596%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author.html"><span><span>author</span></span></a></div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="332140596%2FProperties%2F769193423" anchor-label="author" id="332140596%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author.html"><span><span>author</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="332140596%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="332140596%2FProperties%2F769193423" anchor-label="author" id="332140596%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="332140596%2FProperties%2F769193423" anchor-label="author" id="332140596%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">Name submitted with the comment.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Name submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="763933098%2FProperties%2F769193423" anchor-label="authorEmail" id="763933098%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-email.html"><span>author</span><wbr></wbr><span><span>Email</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-email.html"><span>author</span><wbr></wbr><span><span>Email</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="763933098%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="763933098%2FProperties%2F769193423" anchor-label="authorEmail" id="763933098%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="763933098%2FProperties%2F769193423" anchor-label="authorEmail" id="763933098%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">Email address submitted with the comment.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Email address submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1877068151%2FProperties%2F769193423" anchor-label="authorUrl" id="1877068151%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-url.html"><span>author</span><wbr></wbr><span><span>Url</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-url.html"><span>author</span><wbr></wbr><span><span>Url</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1877068151%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1877068151%2FProperties%2F769193423" anchor-label="authorUrl" id="1877068151%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="1877068151%2FProperties%2F769193423" anchor-label="authorUrl" id="1877068151%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">URL submitted with comment.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">URL submitted with comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="351987025%2FProperties%2F769193423" anchor-label="blogCharset" id="351987025%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-charset.html"><span>blog</span><wbr></wbr><span><span>Charset</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-charset.html"><span>blog</span><wbr></wbr><span><span>Charset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="351987025%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="351987025%2FProperties%2F769193423" anchor-label="blogCharset" id="351987025%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="351987025%2FProperties%2F769193423" anchor-label="blogCharset" id="351987025%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1858576431%2FProperties%2F769193423" anchor-label="blogLang" id="1858576431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-lang.html"><span>blog</span><wbr></wbr><span><span>Lang</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-lang.html"><span>blog</span><wbr></wbr><span><span>Lang</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1858576431%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1858576431%2FProperties%2F769193423" anchor-label="blogLang" id="1858576431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="1858576431%2FProperties%2F769193423" anchor-label="blogLang" id="1858576431%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-166043134%2FProperties%2F769193423" anchor-label="content" id="-166043134%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content.html"><span><span>content</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content.html"><span><span>content</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-166043134%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-166043134%2FProperties%2F769193423" anchor-label="content" id="-166043134%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="-166043134%2FProperties%2F769193423" anchor-label="content" id="-166043134%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The content that was submitted.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The content that was submitted.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-2145557861%2FProperties%2F769193423" anchor-label="dateGmt" id="-2145557861%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-gmt.html"><span>date</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-gmt.html"><span>date</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2145557861%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-2145557861%2FProperties%2F769193423" anchor-label="dateGmt" id="-2145557861%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="-2145557861%2FProperties%2F769193423" anchor-label="dateGmt" id="-2145557861%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1505739261%2FProperties%2F769193423" anchor-label="isTest" id="-1505739261%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-test.html"><span>is</span><wbr></wbr><span><span>Test</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-test.html"><span>is</span><wbr></wbr><span><span>Test</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1505739261%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1505739261%2FProperties%2F769193423" anchor-label="isTest" id="-1505739261%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-test.html">isTest</a><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></div><div class="brief "><a data-name="-1505739261%2FProperties%2F769193423" anchor-label="isTest" id="-1505739261%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-test.html">isTest</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">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1733570640%2FProperties%2F769193423" anchor-label="permalink" id="1733570640%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="permalink.html"><span><span>permalink</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="permalink.html"><span><span>permalink</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1733570640%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1733570640%2FProperties%2F769193423" anchor-label="permalink" id="1733570640%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="1733570640%2FProperties%2F769193423" anchor-label="permalink" id="1733570640%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="981159414%2FProperties%2F769193423" anchor-label="postModifiedGmt" id="981159414%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="post-modified-gmt.html"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="post-modified-gmt.html"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="981159414%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="981159414%2FProperties%2F769193423" anchor-label="postModifiedGmt" id="981159414%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="981159414%2FProperties%2F769193423" anchor-label="postModifiedGmt" id="981159414%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-1133067614%2FProperties%2F769193423" anchor-label="recheckReason" id="-1133067614%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="recheck-reason.html"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="recheck-reason.html"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1133067614%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1133067614%2FProperties%2F769193423" anchor-label="recheckReason" id="-1133067614%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="-1133067614%2FProperties%2F769193423" anchor-label="recheckReason" id="-1133067614%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="94610336%2FProperties%2F769193423" anchor-label="referrer" id="94610336%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="referrer.html"><span><span>referrer</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="referrer.html"><span><span>referrer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="94610336%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="94610336%2FProperties%2F769193423" anchor-label="referrer" id="94610336%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="94610336%2FProperties%2F769193423" anchor-label="referrer" id="94610336%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The content of the referer header should be set here.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The content of the referer header should be set here.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="208017777%2FProperties%2F769193423" anchor-label="serverEnv" id="208017777%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="server-env.html"><span>server</span><wbr></wbr><span><span>Env</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="server-env.html"><span>server</span><wbr></wbr><span><span>Env</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="208017777%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="208017777%2FProperties%2F769193423" anchor-label="serverEnv" id="208017777%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></div><div class="brief "><a data-name="208017777%2FProperties%2F769193423" anchor-label="serverEnv" id="208017777%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="-136735259%2FProperties%2F769193423" anchor-label="type" id="-136735259%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-136735259%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-136735259%2FProperties%2F769193423" anchor-label="type" id="-136735259%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="-136735259%2FProperties%2F769193423" anchor-label="type" id="-136735259%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">A string that describes the type of content being sent, such as:</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">A string that describes the type of content being sent, such as:</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1645403169%2FProperties%2F769193423" anchor-label="userAgent" id="1645403169%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-agent.html"><span>user</span><wbr></wbr><span><span>Agent</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-agent.html"><span>user</span><wbr></wbr><span><span>Agent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1645403169%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1645403169%2FProperties%2F769193423" anchor-label="userAgent" id="1645403169%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="727916877%2FProperties%2F769193423" anchor-label="userIp" id="727916877%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-ip.html"><span>user</span><wbr></wbr><span><span>Ip</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-ip.html"><span>user</span><wbr></wbr><span><span>Ip</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="727916877%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="727916877%2FProperties%2F769193423" anchor-label="userIp" id="727916877%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1651039006%2FProperties%2F769193423" anchor-label="userRole" id="1651039006%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-role.html"><span>user</span><wbr></wbr><span><span>Role</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1651039006%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="1651039006%2FProperties%2F769193423" anchor-label="userRole" id="1651039006%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-role.html"><span>user</span><wbr></wbr><span><span>Role</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1651039006%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1651039006%2FProperties%2F769193423" anchor-label="userRole" id="1651039006%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><a data-name="1651039006%2FProperties%2F769193423" anchor-label="userRole" id="1651039006%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p></div></div></div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1602627458%2FFunctions%2F769193423" anchor-label="equals" id="1602627458%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="equals.html"><span><span>equals</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1602627458%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</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">Indicates whether some other object is <i>equal to</i> this one.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1389700900%2FFunctions%2F769193423" anchor-label="hashCode" id="1389700900%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="hash-code.html"><span>hash</span><wbr></wbr><span><span>Code</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1389700900%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</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/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Returns a hash code value for the object.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="662793916%2FFunctions%2F769193423" anchor-label="toJson" id="662793916%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-json.html"><span>to</span><wbr></wbr><span><span>Json</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="662793916%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</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/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1211534835%2FFunctions%2F769193423" anchor-label="toString" id="1211534835%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-string.html"><span>to</span><wbr></wbr><span><span>String</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1211534835%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</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/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
@ -440,7 +439,8 @@
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>isTest</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/isTest/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/isTest/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">isTest</span></div>
<div class="cover ">
<h1 class="cover"><span>is</span><wbr></wbr><span><span>Test</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-test.html">isTest</a><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 class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L206">source</a>)</span></span></div><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L207">source</a>)</span></span></div><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to 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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>permalink</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/permalink/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/permalink/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">permalink</span></div>
<div class="cover ">
<h1 class="cover"><span><span>permalink</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L103">source</a>)</span></span></div><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L104">source</a>)</span></span></div><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>postModifiedGmt</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/postModifiedGmt/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/postModifiedGmt/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">postModifiedGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>post</span><wbr></wbr><span>Modified</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L168">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L173">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>recheckReason</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/recheckReason/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/recheckReason/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">recheckReason</span></div>
<div class="cover ">
<h1 class="cover"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L209">source</a>)</span></span></div><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p><p class="paragraph">For example: <code class="lang-kotlin">edit</code></p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L216">source</a>)</span></span></div><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p><p class="paragraph">For example: <code class="lang-kotlin">edit</code></p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>referrer</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/referrer/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/referrer/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">referrer</span></div>
<div class="cover ">
<h1 class="cover"><span><span>referrer</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L97">source</a>)</span></span></div><p class="paragraph">The content of the referer header should be set here.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L98">source</a>)</span></span></div><p class="paragraph">The content of the referer header should be set here.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>serverEnv</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/serverEnv/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/serverEnv/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">serverEnv</span></div>
<div class="cover ">
<h1 class="cover"><span>server</span><wbr></wbr><span><span>Env</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L221">source</a>)</span></span></div><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p><p class="paragraph">How the submitted content interacts with the server can be very telling, so please include as much of it as possible.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L229">source</a>)</span></span></div><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p><p class="paragraph">How the submitted content interacts with the server can be very telling, so please include as much of it as possible.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>toJson</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toJson/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toJson/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toJson</span></div>
<div class="cover ">
<h1 class="cover"><span>to</span><wbr></wbr><span><span>Json</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</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/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L248">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</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/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L253">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>toString</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toString/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toString/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toString</span></div>
<div class="cover ">
<h1 class="cover"><span>to</span><wbr></wbr><span><span>String</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</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/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L257">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</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/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L262">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>type</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/type/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/type/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">type</span></div>
<div class="cover ">
<h1 class="cover"><span><span>type</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L109">source</a>)</span></span></div><p class="paragraph">A string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a></p></li></ul><p class="paragraph">You may send a value not listed above if none of them accurately describe your content.</p><p class="paragraph">This is further explained <a href="http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/">here</a>.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L127">source</a>)</span></span></div><p class="paragraph">A string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a></p></li></ul><p class="paragraph">You may send a value not listed above if none of them accurately describe your content.</p><p class="paragraph">This is further explained <a href="http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/">here</a>.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>userAgent</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userAgent/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userAgent/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userAgent</span></div>
<div class="cover ">
<h1 class="cover"><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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>userIp</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userIp/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userIp/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userIp</span></div>
<div class="cover ">
<h1 class="cover"><span>user</span><wbr></wbr><span><span>Ip</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>userRole</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userRole/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userRole/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userRole</span></div>
<div class="cover ">
<h1 class="cover"><span>user</span><wbr></wbr><span><span>Role</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L196">source</a>)</span></span></div><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p><p class="paragraph">If you set it to <a href="-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return false.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L201">source</a>)</span></span></div><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p><p class="paragraph">If you set it to <a href="-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return false.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/Akismet/#kotlin.String#kotlin.String/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/Akismet/#kotlin.String#kotlin.String/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet.html"><span class="token function">Akismet</span></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 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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L226">source</a>)</span></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"></span><span class="token keyword">fun </span><a href="-akismet.html"><span class="token function">Akismet</span></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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L58">source</a>)</span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L226">source</a>)</span></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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L58">source</a>)</span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion/dateToGmt/#java.util.Date/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion/dateToGmt/#java.util.Date/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L70">source</a>)</span></span></div><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><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><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L83">source</a>)</span></span></div><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L77">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L90">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

99
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,61 +34,71 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion///PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L59">source</a>)</span></span></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
<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">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1844418243%2FFunctions%2F769193423" anchor-label="dateToGmt" id="1844418243%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-to-gmt.html"><span>date</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1844418243%2FFunctions%2F769193423" anchor-label="dateToGmt" id="1844418243%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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 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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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/javase/8/docs/api/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>
</div>
<a data-name="1924768251%2FFunctions%2F769193423" anchor-label="jsonComment" id="1924768251%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="json-comment.html"><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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 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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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>
@ -100,7 +112,8 @@
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion/jsonComment/#kotlin.String/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion/jsonComment/#kotlin.String/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L60">source</a>)</span></span></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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L66">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/appUserAgent/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/appUserAgent/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L112">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L125">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/blog.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/blog/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/blog/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L103">source</a>)</span></span></div><p class="paragraph">The URL registered with Akismet.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L106">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/checkComment/#net.thauvin.erik.akismet.AkismetComment#kotlin.Boolean/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/checkComment/#net.thauvin.erik.akismet.AkismetComment#kotlin.Boolean/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L255">source</a>)</span></span></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 data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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"><div data-togglable="Parameters"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error.</p></div></div></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L272">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/debugHelp/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/debugHelp/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L187">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L198">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/error-message.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/errorMessage/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/errorMessage/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L151">source</a>)</span></span></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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L158">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/executeMethod/#okhttp3.HttpUrl#okhttp3.FormBody#kotlin.Boolean/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/executeMethod/#okhttp3.HttpUrl#okhttp3.FormBody#kotlin.Boolean/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L318">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>api</span><wbr></wbr><span><span>Url</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>form</span><wbr></wbr><span><span>Body</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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"><div data-togglable="Parameters"><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>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L326">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error (IO, empty response, etc.)</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/httpStatusCode/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/httpStatusCode/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token constant">0</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L135">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L139">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

514
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,322 +34,323 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet///PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L52">source</a>)</span></span></div><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L58">source</a>)</span></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="Types">Types</button><button class="section-tab" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<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">
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="-1380608589%2FConstructors%2F769193423" anchor-label="Akismet" id="-1380608589%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<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="-1380608589%2FConstructors%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet.html"><span class="token function">Akismet</span></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 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></div>
</div>
</div>
</div>
</div>
<a data-name="263099726%2FConstructors%2F769193423" anchor-label="Akismet" id="263099726%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<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="263099726%2FConstructors%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-akismet.html"><span class="token function">Akismet</span></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><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 data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="708515701%2FConstructors%2F769193423" anchor-label="Akismet" id="708515701%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/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>
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="-619578907%2FClasslikes%2F769193423" anchor-label="Companion" id="-619578907%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-619578907%2FClasslikes%2F769193423" anchor-label="Companion" id="-619578907%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
<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=":dokkaHtml/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>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="158460567%2FFunctions%2F769193423" anchor-label="checkComment" id="158460567%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><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="1280463836%2FFunctions%2F769193423" anchor-label="executeMethod" id="1280463836%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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="1280463836%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</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%2F769193423" anchor-label="reset" id="-707138897%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reset.html"><span><span>reset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-707138897%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="submitHam" id="-1211675440%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="submitSpam" id="-578133801%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="verifyKey" id="869122104%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Key Verification.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="140563587%2FProperties%2F769193423" anchor-label="appUserAgent" id="140563587%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="app-user-agent.html"><span>app</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Agent</span></span></a></div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="140563587%2FProperties%2F769193423" anchor-label="appUserAgent" id="140563587%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="140563587%2FProperties%2F769193423" anchor-label="appUserAgent" id="140563587%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="140563587%2FProperties%2F769193423" anchor-label="appUserAgent" id="140563587%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The application user agent to be sent to Akismet.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="-1491328806%2FProperties%2F769193423" anchor-label="blog" id="-1491328806%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog.html"><span><span>blog</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog.html"><span><span>blog</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1491328806%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1491328806%2FProperties%2F769193423" anchor-label="blog" id="-1491328806%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="-1491328806%2FProperties%2F769193423" anchor-label="blog" id="-1491328806%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The URL registered with Akismet.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="1839698666%2FProperties%2F769193423" anchor-label="debugHelp" id="1839698666%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="debug-help.html"><span>debug</span><wbr></wbr><span><span>Help</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1839698666%2FProperties%2F769193423" anchor-label="debugHelp" id="1839698666%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="1839698666%2FProperties%2F769193423" anchor-label="debugHelp" id="1839698666%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><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 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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="-1854217411%2FProperties%2F769193423" anchor-label="errorMessage" id="-1854217411%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="error-message.html"><span>error</span><wbr></wbr><span><span>Message</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1854217411%2FProperties%2F769193423" anchor-label="errorMessage" id="-1854217411%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="-1854217411%2FProperties%2F769193423" anchor-label="errorMessage" id="-1854217411%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The error message.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="1217730997%2FProperties%2F769193423" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="http-status-code.html"><span>http</span><wbr></wbr><span>Status</span><wbr></wbr><span><span>Code</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1217730997%2FProperties%2F769193423" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token constant">0</span></div><div class="brief "><a data-name="1217730997%2FProperties%2F769193423" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><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="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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="1920554762%2FProperties%2F769193423" anchor-label="isDiscard" id="1920554762%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-discard.html"><span>is</span><wbr></wbr><span><span>Discard</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1920554762%2FProperties%2F769193423" anchor-label="isDiscard" id="1920554762%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token boolean">false</span></div><div class="brief "><a data-name="1920554762%2FProperties%2F769193423" anchor-label="isDiscard" id="1920554762%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><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 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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="2050471377%2FProperties%2F769193423" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-verified-key.html"><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="2050471377%2FProperties%2F769193423" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token boolean">false</span></div><div class="brief "><a data-name="2050471377%2FProperties%2F769193423" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
</div>
<a data-name="1616027372%2FProperties%2F769193423" anchor-label="logger" id="1616027372%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="logger.html"><span><span>logger</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="logger.html"><span><span>logger</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1616027372%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1616027372%2FProperties%2F769193423" anchor-label="logger" id="1616027372%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html">Logger</a></div><div class="brief "><a data-name="1616027372%2FProperties%2F769193423" anchor-label="logger" id="1616027372%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The logger instance.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/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>
</div>
<a data-name="42530702%2FProperties%2F769193423" anchor-label="proTip" id="42530702%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="pro-tip.html"><span>pro</span><wbr></wbr><span><span>Tip</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="42530702%2FProperties%2F769193423" anchor-label="proTip" id="42530702%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="42530702%2FProperties%2F769193423" anchor-label="proTip" id="42530702%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><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 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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="response" id="-1549072997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="response.html"><span><span>response</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1549072997%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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>
<a data-name="-1549072997%2FProperties%2F769193423" anchor-label="response" id="-1549072997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="response.html"><span><span>response</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1549072997%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1549072997%2FProperties%2F769193423" anchor-label="response" id="-1549072997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><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 "><a data-name="-1549072997%2FProperties%2F769193423" anchor-label="response" id="-1549072997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><p class="paragraph">The actual response sent by Akismet from the last operation.</p></div></div></div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="158460567%2FFunctions%2F769193423" anchor-label="checkComment" id="158460567%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><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="1280463836%2FFunctions%2F769193423" anchor-label="executeMethod" id="1280463836%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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="1280463836%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</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%2F769193423" anchor-label="reset" id="-707138897%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reset.html"><span><span>reset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-707138897%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="submitHam" id="-1211675440%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="submitSpam" id="-578133801%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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%2F769193423" anchor-label="verifyKey" id="869122104%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<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%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Key Verification.</p></div></div></div>
</div>
</div>
</div>
</div>
@ -361,7 +364,8 @@
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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isDiscard/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isDiscard/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token boolean">false</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L175">source</a>)</span></span></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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L184">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isVerifiedKey/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isVerifiedKey/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="token operator"> = </span><span class="token boolean">false</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L127">source</a>)</span></span></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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L132">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/logger.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/logger/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/logger/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html">Logger</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L201">source</a>)</span></span></div><p class="paragraph">The logger instance.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html">Logger</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L204">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/proTip/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/proTip/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L161">source</a>)</span></span></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 data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L172">source</a>)</span></span></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=":dokkaHtml/main" data-filterable-set=":dokkaHtml/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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/reset.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/reset/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/reset/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L368">source</a>)</span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L372">source</a>)</span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/response.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/response/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/response/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L142">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L148">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitHam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitHam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L296">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L314">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

55
docs/akismet-kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L276">source</a>)</span></span></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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><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><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L292">source</a>)</span></span></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>© 2023 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>
</div>
</body>
</html>

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

@ -1,10 +1,11 @@
<!DOCTYPE html>
<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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,38 +34,47 @@
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration//769193423">
</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="akismet-kotlin::net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L233">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div data-togglable="See also"><div class="table" data-togglable="See also"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L246">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-verified-key.html"><span>Akismet.</span><wbr></wbr><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

99
docs/akismet-kotlin/net.thauvin.erik.akismet/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>net.thauvin.erik.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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,60 +34,70 @@
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet////PointingToDeclaration//769193423">
</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="package" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet////PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../index.html">akismet-kotlin</a><span class="delimiter">/</span><span class="current">net.thauvin.erik.akismet</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button></div>
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="742337827%2FClasslikes%2F769193423" anchor-label="Akismet" id="742337827%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet/index.html"><span><span>Akismet</span></span></a></div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="742337827%2FClasslikes%2F769193423" anchor-label="Akismet" id="742337827%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet/index.html"><span><span>Akismet</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="742337827%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-akismet/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><div class="brief "><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-akismet/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><div class="brief "><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<a data-name="794089888%2FClasslikes%2F769193423" anchor-label="AkismetComment" id="794089888%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment/index.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment/index.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="794089888%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>userIp<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 "><span class="token keyword">val </span>userAgent<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">A comment to send to Akismet.</p></div></div></div>
<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=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">open </span><span class="token keyword">class </span><a href="-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>userIp<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 "><span class="token keyword">val </span>userAgent<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">A comment to send to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
@ -99,7 +111,8 @@
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>
</div>
</body>
</html>

5
docs/images/burger.svg Normal file
View file

@ -0,0 +1,5 @@
<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M23.3379 5.83331H4.67126V8.16665H23.3379V5.83331Z" fill="white"/>
<path d="M23.3379 12.8333H4.67126V15.1666H23.3379V12.8333Z" fill="white"/>
<path d="M4.67126 19.8333H23.3379V22.1666H4.67126V19.8333Z" fill="white"/>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 339 B

9
docs/images/nav-icons/typealias-kotlin.svg Normal file
View file

@ -0,0 +1,9 @@
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
<g id="typeAlias">
<path id="Vector" fill-rule="evenodd" clip-rule="evenodd" d="M8 15C4.134 15 1 11.866 1 8C1 4.134 4.134 1 8 1C11.866 1 15 4.134 15 8H8V15Z" fill="#B99BF8" fill-opacity="0.6"/>
<path id="Vector_2" fill-rule="evenodd" clip-rule="evenodd" d="M8.5 8H8V11H7.5V6H5.5V5H10.5V6H8.5V8Z" fill="#231F20" fill-opacity="0.7"/>
<g id="&#226;&#140;&#152;/modifier/kotlin">
<path id="&#226;&#140;&#152;/modifier/kotlin_2" d="M16 16H9V9H16L12.4 12.4L16 16Z" fill="#B99BF8"/>
</g>
</g>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 589 B

5
docs/images/theme-toggle.svg
View file

@ -1,4 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24">
<path fill="white" fill-rule="evenodd" clip-rule="evenodd"
d="M0 9a9 9 0 1018 0A9 9 0 000 9zm16 0a7 7 0 01-7 7V2a7 7 0 017 7z" transform="translate(3, 3)"></path>
<svg width="40" height="40" viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M19.9824 29.0078C21.7625 29.0078 23.5025 28.48 24.9826 27.491C26.4626 26.5021 27.6161 25.0965 28.2973 23.452C28.9785 21.8074 29.1568 19.9978 28.8095 18.252C28.4622 16.5062 27.6051 14.9025 26.3464 13.6439C25.0877 12.3852 23.4841 11.528 21.7382 11.1807C19.9924 10.8335 18.1828 11.0117 16.5383 11.6929C14.8937 12.3741 13.4881 13.5276 12.4992 15.0077C11.5103 16.4877 10.9824 18.2278 10.9824 20.0078C10.9851 22.3939 11.9342 24.6816 13.6214 26.3688C15.3087 28.0561 17.5963 29.0051 19.9824 29.0078ZM19.9824 13.0078C21.8389 13.0078 23.6194 13.7453 24.9322 15.0581C26.2449 16.3708 26.9824 18.1513 26.9824 20.0078C26.9824 21.8643 26.2449 23.6448 24.9322 24.9576C23.6194 26.2703 21.8389 27.0078 19.9824 27.0078V13.0078Z" fill="white"/>
</svg>
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 247 B

After

Width:  |  Height:  |  Size: 840 B

Before After
Before After

60
docs/index.html
View file

@ -1,10 +1,11 @@
<!DOCTYPE html>
<html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>akismet-kotlin</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
@ -18,12 +19,13 @@
}
}
</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/jetbrains-mono.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>
@ -32,25 +34,33 @@
<script type="text/javascript" src="scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="index.html">
<span>akismet-kotlin</span>
</a>
<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">
akismet-kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
</div>
</div>
<div>
0.9.3-SNAPSHOT </div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></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>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="akismet-kotlin::////PointingToDeclaration//769193423">
<div class="breadcrumbs"></div>
<div class="cover ">
@ -67,18 +77,24 @@
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2027433751%2FPackages%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right"></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag jvm-like">jvm</div>
</div>
</div>
</div>
<div></div>
</div>
aaaaaaaa
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
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>
</div>
</body>
</html>

2
docs/scripts/main.js
View file

File diff suppressed because one or more lines are too long

2
docs/scripts/pages.json
View file

File diff suppressed because one or more lines are too long

68
docs/scripts/platform-content-handler.js
View file

@ -82,7 +82,7 @@ const samplesAreEnabled = () => {
const initHidingLeftNavigation = () => {
document.getElementById("leftToggler").onclick = function (event) {
document.getElementById("menu-toggle").onclick = function (event) {
//Events need to be prevented from bubbling since they will trigger next handler
event.preventDefault();
event.stopPropagation();
@ -129,22 +129,39 @@ function handleAnchor() {
highlightedAnchor = null;
}
let searchForTab = function (element) {
let searchForContentTarget = function (element) {
if (element && element.hasAttribute) {
if (element.hasAttribute("data-togglable")) return element;
else return searchForTab(element.parentNode)
if (element.hasAttribute("data-togglable")) return element.getAttribute("data-togglable");
else return searchForContentTarget(element.parentNode)
} else return null
}
let findAnyTab = function (target) {
let result = null
document.querySelectorAll('div[tabs-section] > button[data-togglable]')
.forEach(node => {
if(node.getAttribute("data-togglable").split(",").includes(target)) {
result = node
}
})
return result
}
let anchor = window.location.hash
if (anchor != "") {
anchor = anchor.substring(1)
let element = document.querySelector('a[data-name="' + anchor + '"]')
if (element) {
let tab = searchForTab(element)
if (tab) {
toggleSections(tab)
}
const content = element.nextElementSibling
const contentStyle = window.getComputedStyle(content)
if(contentStyle.display == 'none') {
let tab = findAnyTab(searchForContentTarget(content))
if (tab) {
toggleSections(tab)
}
}
if (content) {
content.classList.add('anchor-highlight')
highlightedAnchor = content
@ -174,10 +191,7 @@ function initTabs() {
function showCorrespondingTabBody(element) {
const buttonWithKey = element.querySelector("button[data-active]")
if (buttonWithKey) {
const key = buttonWithKey.getAttribute("data-togglable")
document.querySelector(".tabs-section-body")
.querySelector("div[data-togglable='" + key + "']")
.setAttribute("data-active", "")
toggleSections(buttonWithKey)
}
}
@ -249,7 +263,6 @@ function removeSourcesetFilterFromCache(sourceset) {
}
function toggleSections(target) {
localStorage.setItem('active-tab', JSON.stringify(target.getAttribute("data-togglable")))
const activateTabs = (containerClass) => {
for (const element of document.getElementsByClassName(containerClass)) {
for (const child of element.children) {
@ -261,13 +274,24 @@ function toggleSections(target) {
}
}
}
const toggleTargets = target.getAttribute("data-togglable").split(",")
const activateTabsBody = (containerClass) => {
document.querySelectorAll("." + containerClass + " *[data-togglable]")
.forEach(child => {
if (toggleTargets.includes(child.getAttribute("data-togglable"))) {
child.setAttribute("data-active", "")
} else if(!child.classList.contains("sourceset-dependent-content")) { // data-togglable is used to switch source set as well, ignore it
child.removeAttribute("data-active")
}
})
}
activateTabs("tabs-section")
activateTabs("tabs-section-body")
activateTabsBody("tabs-section-body")
}
function toggleSectionsEventHandler(evt) {
if (!evt.target.getAttribute("data-togglable")) return
localStorage.setItem('active-tab', JSON.stringify(evt.target.getAttribute("data-togglable")))
toggleSections(evt.target)
}
@ -298,13 +322,23 @@ function refreshFiltering() {
document.querySelectorAll("[data-filterable-set]")
.forEach(
elem => {
let platformList = elem.getAttribute("data-filterable-set").split(' ').filter(v => -1 !== sourcesetList.indexOf(v))
elem.setAttribute("data-filterable-current", platformList.join(' '))
let platformList = elem.getAttribute("data-filterable-set").split(',').filter(v => -1 !== sourcesetList.indexOf(v))
elem.setAttribute("data-filterable-current", platformList.join(','))
}
)
refreshFilterButtons()
refreshPlatformTabs()
refreshNoContentNotification()
refreshPlaygroundSamples()
}
function refreshPlaygroundSamples() {
document.querySelectorAll('code.runnablesample').forEach(node => {
const playground = node.KotlinPlayground;
/* Some samples may be hidden by filter, they have 0px height for visible code area
* after rendering. Call this method for re-calculate code area height */
playground && playground.view.codemirror.refresh();
});
}
function refreshNoContentNotification() {

32
docs/styles/font-jb-sans-auto.css Normal file
View file

@ -0,0 +1,32 @@
/* Light weight */
@font-face {
font-family: 'JetBrains Sans';
src: url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-Light.woff2') format('woff2'), url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-Light.woff') format('woff');
font-weight: 300;
font-style: normal;
}
/* Regular weight */
@font-face {
font-family: 'JetBrains Sans';
src: url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-Regular.woff2') format('woff2'), url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-Regular.woff') format('woff');
font-weight: 400;
font-style: normal;
}
/* SemiBold weight */
@font-face {
font-family: 'JetBrains Sans';
src: url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-SemiBold.woff2') format('woff2'), url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans-SemiBold.woff') format('woff');
font-weight: 600;
font-style: normal;
}
@supports (font-variation-settings: normal) {
@font-face {
font-family: 'JetBrains Sans';
src: url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans.woff2') format('woff2 supports variations'),
url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans.woff2') format('woff2-variations'),
url('https://resources.jetbrains.com/storage/jetbrains-sans/JetBrainsSans.woff') format('woff-variations');
font-weight: 100 900;
font-style: normal;
}
}

18
docs/styles/logo-styles.css
View file

@ -1,15 +1,5 @@
.library-name a {
position: relative;
margin-left: 55px;
}
.library-name a::before {
content: '';
background: url("../images/logo-icon.svg") center no-repeat;
background-size: contain;
position: absolute;
width: 50px;
height: 50px;
top: -18px;
left: -55px;
:root {
--dokka-logo-image-url: url('../images/logo-icon.svg');
--dokka-logo-height: 50px;
--dokka-logo-width: 50px;
}

2
docs/styles/main.css
View file

@ -1,4 +1,4 @@
.search button{margin-top:10px;cursor:pointer;border:none;background:var(--color-dark);fill:#fff;fill:var(--dark-mode-and-search-icon-color)}.search button:focus{outline:none}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important}
#pages-search{cursor:pointer;border:none;border-radius:50%;background:transparent;fill:#fff;fill:var(--dark-mode-and-search-icon-color)}#pages-search:focus{outline:none}#pages-search:hover{background:var(--white-10)}.search,.search [data-test=ring-select],.search [data-test=ring-tooltip],.search [data-test=ring-select_focus],.search #pages-search{display:inline-block;padding:0;margin:0;font-size:0;line-height:0}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important}
/* stylelint-disable color-no-hex */
:root {

1040
docs/styles/style.css
View file

File diff suppressed because it is too large Load diff

2
examples/build.gradle.kts
View file

@ -20,7 +20,7 @@ dependencies {
// implementation("javax.servlet:javax.servlet-api:4.0.1")
implementation("jakarta.servlet:jakarta.servlet-api:6.0.0")
implementation("net.thauvin.erik:akismet-kotlin:0.9.3-SNAPSHOT")
implementation("net.thauvin.erik:akismet-kotlin:1.0.0")
}
java {

8
pom.xml
View file

@ -8,7 +8,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>net.thauvin.erik</groupId>
<artifactId>akismet-kotlin</artifactId>
<version>0.9.3-SNAPSHOT</version>
<version>1.0.0</version>
<name>akismet-kotlin</name>
<description>A client library for accessing the Automattic Kismet (Akismet) spam comments filtering service.</description>
<url>https://github.com/ethauvin/akismet-kotlin</url>
@ -65,6 +65,12 @@
<version>4.11.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.squareup.okio</groupId>
<artifactId>okio-jvm</artifactId>
<version>3.5.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>logging-interceptor</artifactId>

10
version.properties
View file

@ -1,9 +1,9 @@
#Generated by the Semver Plugin for Gradle
#Sun May 02 22:00:05 PDT 2021
version.buildmeta=
version.major=0
version.minor=9
version.patch=3
version.prerelease=SNAPSHOT
version.major=1
version.minor=0
version.patch=0
version.prerelease=
version.project=Akismet Kotlin
version.semver=0.9.3-SNAPSHOT
version.semver=1.0.0