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

Added a data class for the comment types

Browse source
This commit is contained in:
Erik C. Thauvin 2024-05-24 17:15:15 -07:00
parent 156d85fee1
commit 0480a72c30
Signed by: erik
GPG key ID: 776702A6A2DA330E
100 changed files with 1760 additions and 343 deletions
Download patch file Download diff file Expand all files Collapse all files

2
config/detekt/baseline.xml
View file

@ -5,7 +5,7 @@
<ID>CyclomaticComplexMethod:Akismet.kt$Akismet$private fun buildFormBody(comment: AkismetComment): FormBody</ID>
<ID>CyclomaticComplexMethod:AkismetComment.kt$AkismetComment$@Suppress("DuplicatedCode") override fun equals(other: Any?): Boolean</ID>
<ID>LongParameterList:AkismetServlet.kt$AkismetServlet$( id: String, name: String?, email: String?, date: String?, comment: String?, json: String, isSpam: Boolean )</ID>
<ID>LongParameterList:CommentConfig.kt$CommentConfig$( var userIp: String, var userAgent: String, var referrer: String = "", var permalink: String = "", var type: String = "", var author: String = "", var authorEmail: String = "", var authorUrl: String = "", var content: String = "", var dateGmt: String = "", var postModifiedGmt: String = "", var blogLang: String = "", var blogCharset: String = "", var userRole: String = "", var isTest: Boolean = false, var recheckReason: String = "", var serverEnv: Map&lt;String, String&gt; = emptyMap() )</ID>
<ID>LongParameterList:CommentConfig.kt$CommentConfig$( var userIp: String, var userAgent: String, var referrer: String = "", var permalink: String = "", var type: CommentType = CommentType.NONE, var author: String = "", var authorEmail: String = "", var authorUrl: String = "", var content: String = "", var dateGmt: String = "", var postModifiedGmt: String = "", var blogLang: String = "", var blogCharset: String = "", var userRole: String = "", var isTest: Boolean = false, var recheckReason: String = "", var serverEnv: Map&lt;String, String&gt; = emptyMap() )</ID>
<ID>MagicNumber:Akismet.kt$Akismet$12</ID>
<ID>MagicNumber:Akismet.kt$Akismet$8</ID>
<ID>NestedBlockDepth:Akismet.kt$Akismet$@JvmOverloads fun executeMethod(apiUrl: HttpUrl, formBody: FormBody, trueOnError: Boolean = false): Boolean</ID>

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

@ -66,7 +66,7 @@
<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="root/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><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span></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#L229">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="root/main" data-filterable-set="root/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 ">config<span class="token operator">: </span><a href="../-comment-config/index.html">CommentConfig</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#L246">source</a>)</span></span></div><br><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#L59">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="root/main" data-filterable-set="root/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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span></span></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#L212">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="root/main" data-filterable-set="root/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 ">config<span class="token operator">: </span><a href="../-comment-config/index.html">CommentConfig</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#L228">source</a>)</span></span></div><br><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#L59">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="root/main" data-filterable-set="root/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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/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#L92">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="root/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#L64">source</a>)</span></span></div><p class="paragraph">Administrator role. If used, Akismet will always return <code class="lang-kotlin">false</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>© 2024 Copyright</span><span

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

@ -82,157 +82,7 @@
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="40828741%2FProperties%2F-1617659094" anchor-label="TYPE_BLOG_POST" id="40828741%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="1153876899%2FProperties%2F-1617659094" anchor-label="TYPE_COMMENT" id="1153876899%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="1929822549%2FProperties%2F-1617659094" anchor-label="TYPE_CONTACT_FORM" id="1929822549%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="1826794746%2FProperties%2F-1617659094" anchor-label="TYPE_FORUM_POST" id="1826794746%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="1363500795%2FProperties%2F-1617659094" anchor-label="TYPE_MESSAGE" id="1363500795%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="641236959%2FProperties%2F-1617659094" anchor-label="TYPE_PINGBACK" id="641236959%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="-375729480%2FProperties%2F-1617659094" anchor-label="TYPE_REPLY" id="-375729480%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="110004160%2FProperties%2F-1617659094" anchor-label="TYPE_SIGNUP" id="110004160%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="1517505392%2FProperties%2F-1617659094" anchor-label="TYPE_TRACKBACK" id="1517505392%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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>
<a data-name="-551496431%2FProperties%2F-1617659094" anchor-label="TYPE_TWEET" id="-551496431%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-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%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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 <code class="lang-kotlin">false</code>.</p></div></div></div>
</div>
</div>
</div>

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L137">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="root/main"><div class="symbol monospace"><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#L114">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L143">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="root/main"><div class="symbol monospace"><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#L122">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L131">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="root/main"><div class="symbol monospace"><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#L106">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L189">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="root/main"><div class="symbol monospace"><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#L170">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L181">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="root/main"><div class="symbol monospace"><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#L162">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L149">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="root/main"><div class="symbol monospace"><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#L130">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L161">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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="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#L142">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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/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#L286">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="root/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#L268">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/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#L317">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="root/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#L299">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>© 2024 Copyright</span><span

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

@ -315,7 +315,7 @@
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../-comment-type/index.html">CommentType</a></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>

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L205">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="root/main"><div class="symbol monospace"><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#L188">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L102">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="root/main"><div class="symbol monospace"><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#L78">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L171">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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="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#L152">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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L214">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="root/main"><div class="symbol monospace"><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#L197">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L96">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="root/main"><div class="symbol monospace"><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#L70">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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#L227">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="root/main"><div class="symbol monospace"><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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#L210">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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L269">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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="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#L251">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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/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#L278">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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">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#L260">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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L125">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="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../-comment-type/index.html">CommentType</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#L101">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="../-comment-type/-companion/-c-o-m-m-e-n-t.html">CommentType.COMMENT</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-f-o-r-u-m_-p-o-s-t.html">CommentType.FORUM_POST</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-r-e-p-l-y.html">CommentType.REPLY</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-b-l-o-g_-p-o-s-t.html">CommentType.BLOG_POST</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-c-o-n-t-a-c-t_-f-o-r-m.html">CommentType.CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-s-i-g-n-u-p.html">CommentType.SIGNUP</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-m-e-s-s-a-g-e.html">CommentType.MESSAGE</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-p-i-n-g-b-a-c-k.html">CommentType.PINGBACK</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-t-r-a-c-k-b-a-c-k.html">CommentType.TRACKBACK</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-t-w-e-e-t.html">CommentType.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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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#L199">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="root/main"><div class="symbol monospace"><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#L180">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 <code class="lang-kotlin">false</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>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html
View file

@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>Builder</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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/CommentConfig.kt#L96">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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/CommentConfig.kt#L86">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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="root/main" data-filterable-set="root/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>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-email.html"><span class="token function">authorEmail</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorEmail<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L161">source</a>)</span></span></div><p class="paragraph">Sets the email address submitted with the comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L101">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-email.html"><span class="token function">authorEmail</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorEmail<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L151">source</a>)</span></span></div><p class="paragraph">Sets the email address submitted with the comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L91">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-url.html"><span class="token function">authorUrl</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorUrl<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L166">source</a>)</span></span></div><p class="paragraph">Sets the URL submitted with comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L102">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-url.html"><span class="token function">authorUrl</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorUrl<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L156">source</a>)</span></span></div><p class="paragraph">Sets the URL submitted with comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L92">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author.html"><span class="token function">author</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">author<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L156">source</a>)</span></span></div><p class="paragraph">Sets the mame submitted with the comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L100">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author.html"><span class="token function">author</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">author<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L146">source</a>)</span></span></div><p class="paragraph">Sets the mame submitted with the comment.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L90">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-charset.html"><span class="token function">blogCharset</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogCharset<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L199">source</a>)</span></span></div><p class="paragraph">Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L107">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-charset.html"><span class="token function">blogCharset</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogCharset<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L189">source</a>)</span></span></div><p class="paragraph">Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L97">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-lang.html"><span class="token function">blogLang</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogLang<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L194">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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L106">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-lang.html"><span class="token function">blogLang</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogLang<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L184">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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L96">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html
View file

@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>build</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">CommentConfig</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/CommentConfig.kt#L235">source</a>)</span></span></div><p class="paragraph">Builds a new comment configuration.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">CommentConfig</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/CommentConfig.kt#L225">source</a>)</span></span></div><p class="paragraph">Builds a new comment configuration.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="content.html"><span class="token function">content</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">content<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L171">source</a>)</span></span></div><p class="paragraph">Sets the content that was submitted.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L103">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="content.html"><span class="token function">content</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">content<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L161">source</a>)</span></span></div><p class="paragraph">Sets the content that was submitted.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L93">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-gmt.html"><span class="token function">dateGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dateGmt<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L180">source</a>)</span></span></div><p class="paragraph">Sets 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="root/main" data-filterable-set="root/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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L104">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-gmt.html"><span class="token function">dateGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dateGmt<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L170">source</a>)</span></span></div><p class="paragraph">Sets 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="root/main" data-filterable-set="root/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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L94">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

12
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html
View file

@ -65,7 +65,7 @@
<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">CommentConfig</a><span class="delimiter">/</span><span class="current">Builder</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Builder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Builder</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </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">var </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/CommentConfig.kt#L96">source</a>)</span></span></div><p class="paragraph">Provides a configuration builder.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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="root/main" data-filterable-set="root/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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Builder</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </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">var </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/CommentConfig.kt#L86">source</a>)</span></span></div><p class="paragraph">Provides a configuration builder.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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="root/main" data-filterable-set="root/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="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
@ -296,7 +296,7 @@
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</a></div></div></div>
</div>
</div>
</div>
@ -510,7 +510,7 @@
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="post-modified-gmt.html"><span class="token function">postModifiedGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">postModifiedGmt<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><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&gt;</span></div><div class="brief "><p class="paragraph">Sets 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="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="post-modified-gmt.html"><span class="token function">postModifiedGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">postModifiedGmt<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="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets 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>
@ -560,17 +560,17 @@
</div>
</div>
</div>
<a data-name="891136060%2FFunctions%2F-1617659094" anchor-label="type" id="891136060%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<a data-name="-679859672%2FFunctions%2F-1617659094" anchor-label="type" id="-679859672%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="891136060%2FFunctions%2F-1617659094"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-679859672%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="type.html"><span class="token function">type</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<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="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets a string that describes the type of content being sent, such as:</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="type.html"><span class="token function">type</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets a string that describes the type of content being sent, such as:</p></div></div></div>
</div>
</div>
</div>

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="is-test.html"><span class="token function">isTest</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">isTest<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L211">source</a>)</span></span></div><p class="paragraph">This is optional. You can set it when submitting test queries to Akismet.</p><hr><div class="symbol monospace"><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/CommentConfig.kt#L109">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="is-test.html"><span class="token function">isTest</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">isTest<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L201">source</a>)</span></span></div><p class="paragraph">This is optional. You can set it when submitting test queries to Akismet.</p><hr><div class="symbol monospace"><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/CommentConfig.kt#L99">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="permalink.html"><span class="token function">permalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permalink<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L131">source</a>)</span></span></div><p class="paragraph">Sets the full permanent URL of the entry the comment was submitted to.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L98">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="permalink.html"><span class="token function">permalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permalink<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L121">source</a>)</span></span></div><p class="paragraph">Sets the full permanent URL of the entry the comment was submitted to.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L88">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="post-modified-gmt.html"><span class="token function">postModifiedGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">postModifiedGmt<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><span data-unresolved-link="/&amp;lt;Error class: unknown class&amp;gt;///PointingToDeclaration/">&lt;Error class: unknown class&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/CommentConfig.kt#L187">source</a>)</span></span></div><p class="paragraph">Sets 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="root/main" data-filterable-set="root/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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L105">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="post-modified-gmt.html"><span class="token function">postModifiedGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">postModifiedGmt<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L177">source</a>)</span></span></div><p class="paragraph">Sets 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="root/main" data-filterable-set="root/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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L95">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="recheck-reason.html"><span class="token function">recheckReason</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">checkReason<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L220">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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L110">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="recheck-reason.html"><span class="token function">recheckReason</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">checkReason<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L210">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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L100">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="referrer.html"><span class="token function">referrer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">referrer<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L126">source</a>)</span></span></div><p class="paragraph">Sets the content of the referrer header.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L97">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="referrer.html"><span class="token function">referrer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">referrer<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L116">source</a>)</span></span></div><p class="paragraph">Sets the content of the referrer header.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L87">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="server-env.html"><span class="token function">serverEnv</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">serverEnv<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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L230">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><hr><div class="symbol monospace"><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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/CommentConfig.kt#L111">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="server-env.html"><span class="token function">serverEnv</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">serverEnv<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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L220">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><hr><div class="symbol monospace"><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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/CommentConfig.kt#L101">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

4
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html
View file

@ -61,12 +61,12 @@
<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/CommentConfig.Builder/type/#kotlin.String/PointingToDeclaration//-1617659094">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/type/#net.thauvin.erik.akismet.CommentType/PointingToDeclaration//-1617659094">
<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">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="type.html"><span class="token function">type</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L151">source</a>)</span></span></div><p class="paragraph">Sets a string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="../../-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a></p></li><li><p class="paragraph"><a href="../../-akismet-comment/-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="../../-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a></p></li><li><p class="paragraph"><a href="../../-akismet-comment/-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="../../-akismet-comment/-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="../../-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a></p></li><li><p class="paragraph"><a href="../../-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a></p></li><li><p class="paragraph"><a href="../../-akismet-comment/-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="../../-akismet-comment/-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="../../-akismet-comment/-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><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L99">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="type.html"><span class="token function">type</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L141">source</a>)</span></span></div><p class="paragraph">Sets a string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="../../-comment-type/-companion/-c-o-m-m-e-n-t.html">CommentType.COMMENT</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-f-o-r-u-m_-p-o-s-t.html">CommentType.FORUM_POST</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-r-e-p-l-y.html">CommentType.REPLY</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-b-l-o-g_-p-o-s-t.html">CommentType.BLOG_POST</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-c-o-n-t-a-c-t_-f-o-r-m.html">CommentType.CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-s-i-g-n-u-p.html">CommentType.SIGNUP</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-m-e-s-s-a-g-e.html">CommentType.MESSAGE</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-p-i-n-g-b-a-c-k.html">CommentType.PINGBACK</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-t-r-a-c-k-b-a-c-k.html">CommentType.TRACKBACK</a></p></li><li><p class="paragraph"><a href="../../-comment-type/-companion/-t-w-e-e-t.html">CommentType.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><hr><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</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/CommentConfig.kt#L89">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-agent.html"><span class="token function">userAgent</span></a><span class="token punctuation">(</span><span class="parameters "><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="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L121">source</a>)</span></span></div><p class="paragraph">Sets the user agent string of the web browser submitting the comment.</p><hr><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L96">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-agent.html"><span class="token function">userAgent</span></a><span class="token punctuation">(</span><span class="parameters "><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="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L111">source</a>)</span></span></div><p class="paragraph">Sets the user agent string of the web browser submitting the comment.</p><hr><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L86">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-ip.html"><span class="token function">userIp</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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L116">source</a>)</span></span></div><p class="paragraph">Sets the IP address of the comment submitter.</p><hr><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L96">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-ip.html"><span class="token function">userIp</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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</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/CommentConfig.kt#L106">source</a>)</span></span></div><p class="paragraph">Sets the IP address of the comment submitter.</p><hr><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L86">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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>© 2024 Copyright</span><span

2
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html
View file

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-role.html"><span class="token function">userRole</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userRole<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L206">source</a>)</span></span></div><p class="paragraph">Set 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="../../-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return false.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L108">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-role.html"><span class="token function">userRole</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userRole<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="index.html">CommentConfig.Builder</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/CommentConfig.kt#L196">source</a>)</span></span></div><p class="paragraph">Set 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="../../-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return <code class="lang-kotlin">false</code>.</p><hr><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L98">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

File diff suppressed because one or more lines are too long

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L59">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L49">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L60">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L50">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L58">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L48">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L65">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L55">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L64">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L54">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L61">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L51">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L62">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L52">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

File diff suppressed because one or more lines are too long

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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/CommentConfig.kt#L67">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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/CommentConfig.kt#L57">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L56">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L46">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L63">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L53">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L68">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L58">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L55">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L45">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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/CommentConfig.kt#L69">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </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/CommentConfig.kt#L59">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L57">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../-comment-type/index.html">CommentType</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/CommentConfig.kt#L47">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L54">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="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/CommentConfig.kt#L44">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><span class="token keyword">var </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/CommentConfig.kt#L53">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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 class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="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/CommentConfig.kt#L43">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>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>© 2024 Copyright</span><span

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

@ -66,7 +66,7 @@
<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="root/main"><div class="symbol monospace"><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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L66">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">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="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L56">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

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

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>CommentType</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType/CommentType/#kotlin.String/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><span class="current">CommentType</span></div>
<div class="cover ">
<h1 class="cover"><span>Comment</span><wbr></wbr><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="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<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/CommentType.kt#L40">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-b-l-o-g_-p-o-s-t.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>BLOG_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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/BLOG_POST/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">BLOG_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-b-l-o-g_-p-o-s-t.html">BLOG_POST</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L64">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-c-o-m-m-e-n-t.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/COMMENT/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">COMMENT</span></div>
<div class="cover ">
<h1 class="cover"><span><span>COMMENT</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-c-o-m-m-e-n-t.html">COMMENT</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L46">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-c-o-n-t-a-c-t_-f-o-r-m.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/CONTACT_FORM/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">CONTACT_FORM</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-c-o-n-t-a-c-t_-f-o-r-m.html">CONTACT_FORM</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L70">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-f-o-r-u-m_-p-o-s-t.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/FORUM_POST/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">FORUM_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-f-o-r-u-m_-p-o-s-t.html">FORUM_POST</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L52">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-m-e-s-s-a-g-e.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/MESSAGE/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">MESSAGE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>MESSAGE</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-m-e-s-s-a-g-e.html">MESSAGE</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L81">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-n-o-n-e.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>NONE</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/NONE/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">NONE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>NONE</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-n-o-n-e.html">NONE</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L105">source</a>)</span></span></div><p class="paragraph">Undefined type.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-p-i-n-g-b-a-c-k.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/PINGBACK/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">PINGBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-p-i-n-g-b-a-c-k.html">PINGBACK</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L87">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-r-e-p-l-y.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/REPLY/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">REPLY</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-r-e-p-l-y.html">REPLY</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L58">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-s-i-g-n-u-p.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/SIGNUP/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">SIGNUP</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-s-i-g-n-u-p.html">SIGNUP</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L75">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-t-r-a-c-k-b-a-c-k.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/TRACKBACK/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TRACKBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-t-r-a-c-k-b-a-c-k.html">TRACKBACK</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L93">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-t-w-e-e-t.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>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
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion/TWEET/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TWEET</span></div>
<div class="cover ">
<h1 class="cover"><span><span>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="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-t-w-e-e-t.html">TWEET</a><span class="token operator">: </span><a href="../index.html">CommentType</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/CommentType.kt#L99">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>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

254
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/index.html Normal file
View file

@ -0,0 +1,254 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Companion</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion///PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><span class="current">Companion</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Companion</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentType.kt#L41">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="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-2044362414%2FProperties%2F-1617659094" anchor-label="BLOG_POST" id="-2044362414%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-b-l-o-g_-p-o-s-t.html"><span><span>BLOG_POST</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2044362414%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-b-l-o-g_-p-o-s-t.html">BLOG_POST</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A blog post.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1214276848%2FProperties%2F-1617659094" anchor-label="COMMENT" id="1214276848%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-c-o-m-m-e-n-t.html"><span><span>COMMENT</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1214276848%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-c-o-m-m-e-n-t.html">COMMENT</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A blog comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="112125992%2FProperties%2F-1617659094" anchor-label="CONTACT_FORM" id="112125992%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-c-o-n-t-a-c-t_-f-o-r-m.html"><span><span>CONTACT_FORM</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="112125992%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-c-o-n-t-a-c-t_-f-o-r-m.html">CONTACT_FORM</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A contact form or feedback form submission.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1610378381%2FProperties%2F-1617659094" anchor-label="FORUM_POST" id="1610378381%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-f-o-r-u-m_-p-o-s-t.html"><span><span>FORUM_POST</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1610378381%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-f-o-r-u-m_-p-o-s-t.html">FORUM_POST</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A top-level forum post.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1423900744%2FProperties%2F-1617659094" anchor-label="MESSAGE" id="1423900744%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-m-e-s-s-a-g-e.html"><span><span>MESSAGE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1423900744%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-m-e-s-s-a-g-e.html">MESSAGE</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A message sent between just a few users.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="558587443%2FProperties%2F-1617659094" anchor-label="NONE" id="558587443%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-n-o-n-e.html"><span><span>NONE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="558587443%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-n-o-n-e.html">NONE</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">Undefined type.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1781331918%2FProperties%2F-1617659094" anchor-label="PINGBACK" id="-1781331918%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-p-i-n-g-b-a-c-k.html"><span><span>PINGBACK</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1781331918%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-p-i-n-g-b-a-c-k.html">PINGBACK</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A pingback.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="232153925%2FProperties%2F-1617659094" anchor-label="REPLY" id="232153925%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-r-e-p-l-y.html"><span><span>REPLY</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="232153925%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-r-e-p-l-y.html">REPLY</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A reply to a top-level forum post.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1774520531%2FProperties%2F-1617659094" anchor-label="SIGNUP" id="1774520531%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-s-i-g-n-u-p.html"><span><span>SIGNUP</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1774520531%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-s-i-g-n-u-p.html">SIGNUP</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A new user account.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-567685763%2FProperties%2F-1617659094" anchor-label="TRACKBACK" id="-567685763%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-r-a-c-k-b-a-c-k.html"><span><span>TRACKBACK</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-567685763%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-t-r-a-c-k-b-a-c-k.html">TRACKBACK</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A trackback.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="56386974%2FProperties%2F-1617659094" anchor-label="TWEET" id="56386974%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-t-w-e-e-t.html"><span><span>TWEET</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="56386974%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="-t-w-e-e-t.html">TWEET</a><span class="token operator">: </span><a href="../index.html">CommentType</a></div><div class="brief "><p class="paragraph">A Twitter message.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

142
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/index.html Normal file
View file

@ -0,0 +1,142 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>CommentType</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType///PointingToDeclaration//-1617659094">
<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">CommentType</span></div>
<div class="cover ">
<h1 class="cover"><span>Comment</span><wbr></wbr><span><span>Type</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">CommentType</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>value<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/CommentType.kt#L40">source</a>)</span></span></div><p class="paragraph">Defines the comment types.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="1502689072%2FConstructors%2F-1617659094" anchor-label="CommentType" id="1502689072%2FConstructors%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-comment-type.html"><span>Comment</span><wbr></wbr><span><span>Type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1502689072%2FConstructors%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<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></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="712928148%2FClasslikes%2F-1617659094" anchor-label="Companion" id="712928148%2FClasslikes%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="712928148%2FClasslikes%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1107713540%2FProperties%2F-1617659094" anchor-label="value" id="-1107713540%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="value.html"><span><span>value</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1107713540%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="value.html">value</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>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

80
docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/value.html Normal file
View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>value</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.1-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentType/value/#/PointingToDeclaration//-1617659094">
<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">CommentType</a><span class="delimiter">/</span><span class="current">value</span></div>
<div class="cover ">
<h1 class="cover"><span><span>value</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="value.html">value</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/CommentType.kt#L40">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

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

File diff suppressed because one or more lines are too long

29
docs/-akismet -kotlin/package-list
View file

@ -26,16 +26,6 @@ $dokka.location:net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.ak
$dokka.location:net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/ADMIN_ROLE/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_BLOG_POST/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_COMMENT/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_CONTACT_FORM/#/PointingToDeclaration/-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
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_FORUM_POST/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_MESSAGE/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_PINGBACK/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_REPLY/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_SIGNUP/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TRACKBACK/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment/AkismetComment/#[Error type: Unresolved type for HttpServletRequest]/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html
$dokka.location:net.thauvin.erik.akismet/AkismetComment/AkismetComment/#kotlin.String#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html
@ -91,7 +81,7 @@ $dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/referrer/#kotlin.
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/serverEnv/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/serverEnv/#kotlin.collections.Map[kotlin.String,kotlin.String]/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/type/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/type/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/type/#net.thauvin.erik.akismet.CommentType/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userAgent/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userAgent/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userIp/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html
@ -99,7 +89,7 @@ $dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userIp/#kotlin.St
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userRole/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userRole/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/CommentConfig/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/CommentConfig/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#net.thauvin.erik.akismet.CommentType#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/CommentConfig/#net.thauvin.erik.akismet.CommentConfig.Builder/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/author/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/authorEmail/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html
@ -118,5 +108,20 @@ $dokka.location:net.thauvin.erik.akismet/CommentConfig/type/#/PointingToDeclarat
$dokka.location:net.thauvin.erik.akismet/CommentConfig/userAgent/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/userIp/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html
$dokka.location:net.thauvin.erik.akismet/CommentConfig/userRole/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/index.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/BLOG_POST/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-b-l-o-g_-p-o-s-t.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/COMMENT/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-c-o-m-m-e-n-t.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/CONTACT_FORM/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-c-o-n-t-a-c-t_-f-o-r-m.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/FORUM_POST/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-f-o-r-u-m_-p-o-s-t.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/MESSAGE/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-m-e-s-s-a-g-e.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/NONE/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-n-o-n-e.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/PINGBACK/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-p-i-n-g-b-a-c-k.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/REPLY/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-r-e-p-l-y.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/SIGNUP/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-s-i-g-n-u-p.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/TRACKBACK/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-t-r-a-c-k-b-a-c-k.html
$dokka.location:net.thauvin.erik.akismet/CommentType.Companion/TWEET/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/-t-w-e-e-t.html
$dokka.location:net.thauvin.erik.akismet/CommentType///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/index.html
$dokka.location:net.thauvin.erik.akismet/CommentType/CommentType/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-comment-type.html
$dokka.location:net.thauvin.erik.akismet/CommentType/value/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/value.html
net.thauvin.erik.akismet

6
docs/navigation.html
View file

@ -20,6 +20,12 @@
<div class="overview"><a href="-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class-kt"></span><span class="nav-link-child"><span><span>Builder</span></span></span></span></a></div>
</div>
</div>
<div class="sideMenuPart" id="Akismet Kotlin-nav-submenu-0-3" pageId="Akismet Kotlin::net.thauvin.erik.akismet/CommentType///PointingToDeclaration//-1617659094">
<div class="overview"><span class="navButton" onclick="document.getElementById(&quot;Akismet Kotlin-nav-submenu-0-3&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class-kt"></span><span class="nav-link-child"><span>Comment</span><wbr></wbr><span><span>Type</span></span></span></span></a></div>
<div class="sideMenuPart" id="Akismet Kotlin-nav-submenu-0-3-0" pageId="Akismet Kotlin::net.thauvin.erik.akismet/CommentType.Companion///PointingToDeclaration//-1617659094">
<div class="overview"><a href="-akismet -kotlin/net.thauvin.erik.akismet/-comment-type/-companion/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon object"></span><span class="nav-link-child"><span><span>Companion</span></span></span></span></a></div>
</div>
</div>
</div>
</div>

2
docs/scripts/pages.json
View file

File diff suppressed because one or more lines are too long

3
examples/bld/src/bld/java/com/example/ExampleBuild.java
View file

@ -1,13 +1,12 @@
package com.example;
import rife.bld.BaseProject;
import rife.bld.BuildCommand;
import rife.bld.extension.CompileKotlinOperation;
import rife.bld.operations.RunOperation;
import rife.bld.BaseProject;
import java.util.List;
import static rife.bld.dependencies.Repository.*;
import static rife.bld.dependencies.Scope.compile;

3
examples/bld/src/main/java/com/example/AkismetSample.java
View file

@ -3,6 +3,7 @@ package com.example;
import net.thauvin.erik.akismet.Akismet;
import net.thauvin.erik.akismet.AkismetComment;
import net.thauvin.erik.akismet.CommentConfig;
import net.thauvin.erik.akismet.CommentType;
import java.util.Date;
@ -15,7 +16,7 @@ public class AkismetSample {
.isTest(true)
.referrer("https://www.google.com")
.permalink(akismet.getBlog() + "post=1")
.type(AkismetComment.TYPE_COMMENT)
.type(CommentType.COMMENT)
.author("admin")
.authorEmail("test@test.com")
.authorUrl("http://www.CheckOutMyCoolSite.com")

3
examples/bld/src/main/kotlin/com/example/AkismetExample.kt
View file

@ -2,6 +2,7 @@ package com.example
import net.thauvin.erik.akismet.Akismet
import net.thauvin.erik.akismet.AkismetComment
import net.thauvin.erik.akismet.CommentType
import java.util.*
import kotlin.system.exitProcess
@ -12,7 +13,7 @@ fun main(args: Array<String>) {
isTest = true
referrer = "https://www.google.com"
permalink = "${akismet.blog}post=1"
type = AkismetComment.TYPE_COMMENT
type = CommentType.COMMENT
author = "admin"
authorEmail = "test@test.com"
authorUrl = "https://www.CheckOutMyCoolSite.com"

5
examples/bld/src/main/kotlin/com/example/AkismetServlet.kt
View file

@ -7,8 +7,9 @@ import jakarta.servlet.http.HttpServletRequest
import jakarta.servlet.http.HttpServletResponse
import net.thauvin.erik.akismet.Akismet
import net.thauvin.erik.akismet.AkismetComment
import net.thauvin.erik.akismet.CommentType
import java.io.IOException
import java.util.Date
import java.util.*
@WebServlet(description = "Akismet Servlet", displayName = "Akismet", urlPatterns = ["/comment/*"])
class AkismetServlet : HttpServlet() {
@ -22,7 +23,7 @@ class AkismetServlet : HttpServlet() {
val comment = AkismetComment(request).apply {
permalink = "${akismet.blog}/comment/$id"
type = AkismetComment.TYPE_COMMENT
type = CommentType.COMMENT
author = request.getParameter("name")
authorEmail = request.getParameter("email")
dateGmt = Akismet.dateToGmt(Date())

2
examples/gradle/.idea/.name generated
View file

@ -1 +1 @@
akismet-examples-gradle
akismet-kotlin-examples-gradle

3
examples/gradle/.idea/misc.xml generated
View file

@ -6,6 +6,9 @@
<list size="0" />
</component>
<component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="17" project-jdk-type="JavaSDK" />
<component name="SuppressionsComponent">
<option name="suppComments" value="[]" />

13
examples/gradle/.idea/modules.xml generated Normal file
View file

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.iml" filepath="$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.main.iml" filepath="$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.main.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.test.iml" filepath="$PROJECT_DIR$/.idea/modules/akismet-examples-gradle.test.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.iml" filepath="$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.main.iml" filepath="$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.main.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.test.iml" filepath="$PROJECT_DIR$/.idea/modules/gradle.akismet-examples-gradle.test.iml" />
</modules>
</component>
</project>

2
examples/gradle/settings.gradle.kts
View file

@ -7,4 +7,4 @@
* in the user manual at https://docs.gradle.org/5.6.2/userguide/multi_project_builds.html
*/
rootProject.name = "akismet-examples"
rootProject.name = "akismet-kotlin-examples-gradle"

3
examples/gradle/src/main/java/com/example/AkismetSample.java
View file

@ -3,6 +3,7 @@ package com.example;
import net.thauvin.erik.akismet.Akismet;
import net.thauvin.erik.akismet.AkismetComment;
import net.thauvin.erik.akismet.CommentConfig;
import net.thauvin.erik.akismet.CommentType;
import java.util.Date;
@ -15,7 +16,7 @@ public class AkismetSample {
.isTest(true)
.referrer("https://www.google.com")
.permalink(akismet.getBlog() + "post=1")
.type(AkismetComment.TYPE_COMMENT)
.type(CommentType.COMMENT)
.author("admin")
.authorEmail("test@test.com")
.authorUrl("http://www.CheckOutMyCoolSite.com")

3
examples/gradle/src/main/kotlin/com/example/AkismetExample.kt
View file

@ -2,6 +2,7 @@ package com.example
import net.thauvin.erik.akismet.Akismet
import net.thauvin.erik.akismet.AkismetComment
import net.thauvin.erik.akismet.CommentType
import java.util.*
import kotlin.system.exitProcess
@ -12,7 +13,7 @@ fun main(args: Array<String>) {
isTest = true
referrer = "https://www.google.com"
permalink = "${akismet.blog}post=1"
type = AkismetComment.TYPE_COMMENT
type = CommentType.COMMENT
author = "admin"
authorEmail = "test@test.com"
authorUrl = "https://www.CheckOutMyCoolSite.com"

5
examples/gradle/src/main/kotlin/com/example/AkismetServlet.kt
View file

@ -7,8 +7,9 @@ import jakarta.servlet.http.HttpServletRequest
import jakarta.servlet.http.HttpServletResponse
import net.thauvin.erik.akismet.Akismet
import net.thauvin.erik.akismet.AkismetComment
import net.thauvin.erik.akismet.CommentType
import java.io.IOException
import java.util.Date
import java.util.*
@WebServlet(description = "Akismet Servlet", displayName = "Akismet", urlPatterns = ["/comment/*"])
class AkismetServlet : HttpServlet() {
@ -22,7 +23,7 @@ class AkismetServlet : HttpServlet() {
val comment = AkismetComment(request).apply {
permalink = "${akismet.blog}/comment/$id"
type = AkismetComment.TYPE_COMMENT
type = CommentType.COMMENT
author = request.getParameter("name")
authorEmail = request.getParameter("email")
dateGmt = Akismet.dateToGmt(Date())

2
lib/bld/bld-wrapper.properties
View file

@ -2,7 +2,7 @@ bld.downloadExtensionJavadoc=false
bld.downloadExtensionSources=true
bld.extensions=com.uwyn.rife2:bld-generated-version:0.9.5
bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.5
bld.extensions-kotlin=com.uwyn.rife2:bld-kotlin:0.9.5
bld.extensions-kotlin=com.uwyn.rife2:bld-kotlin:0.9.7
bld.extensions-detekt=com.uwyn.rife2:bld-detekt:0.9.4
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
bld.downloadLocation=

5
src/bld/java/net/thauvin/erik/AkismetBuild.java
View file

@ -174,6 +174,9 @@ public class AkismetBuild extends Project {
+ "/tree/master/src/main/kotlin/", "#L")
.includes("config/dokka/packages.md")
.jdkVersion(javaRelease)
.externalDocumentationLinks("https://jakarta.ee/specifications/platform/9/apidocs/",
"https://jakarta.ee/specifications/platform/9/apidocs/package-list")
)
.execute();
}
@ -207,6 +210,8 @@ public class AkismetBuild extends Project {
.moduleVersion(version.toString())
.outputDir(new File(buildDirectory(), "javadoc"))
.outputFormat(OutputFormat.JAVADOC)
.globalLinks("https://jakarta.ee/specifications/platform/9/apidocs/",
"https://jakarta.ee/specifications/platform/9/apidocs/package-list")
.execute();
}

4
src/main/kotlin/net/thauvin/erik/akismet/Akismet.kt
View file

@ -395,8 +395,8 @@ open class Akismet(apiKey: String) {
if (!permalink.isNullOrBlank()) {
add("permalink", permalink.toString())
}
if (!type.isNullOrBlank()) {
add("comment_type", type.toString())
if (type != CommentType.NONE) {
add("comment_type", type.value)
}
if (!author.isNullOrBlank()) {
add("comment_author", author.toString())

92
src/main/kotlin/net/thauvin/erik/akismet/AkismetComment.kt
View file

@ -58,47 +58,23 @@ private fun String?.ifNull() = this ?: ""
@Serializable
open class AkismetComment(val userIp: String, val userAgent: String) {
companion object {
/** A blog comment. */
const val TYPE_COMMENT = "comment"
/** A top-level forum post. */
const val TYPE_FORUM_POST = "forum-post"
/** A reply to a top-level forum post. */
const val TYPE_REPLY = "reply"
/** A blog post. */
const val TYPE_BLOG_POST = "blog-post"
/** A contact form or feedback form submission. */
const val TYPE_CONTACT_FORM = "contact-form"
/** A new user account. */
const val TYPE_SIGNUP = "signup"
/** A message sent between just a few users. */
const val TYPE_MESSAGE = "message"
/** A pingback. */
const val TYPE_PINGBACK = "pingback"
/** A trackback. */
const val TYPE_TRACKBACK = "trackback"
/** A Twitter message. */
const val TYPE_TWEET = "tweet"
/** Administrator role. If used, Akismet will always return false. */
/**
* Administrator role. If used, Akismet will always return `false`.
*/
const val ADMIN_ROLE = "administrator"
}
/** The content of the referer header should be set here. */
/**
* The content of the referer header should be set here.
*/
var referrer: String? = ""
set(value) {
field = value.ifNull()
}
/** The full permanent URL of the entry the comment was submitted to. */
/**
* The full permanent URL of the entry the comment was submitted to.
*/
var permalink: String? = ""
set(value) {
field = value.ifNull()
@ -107,45 +83,50 @@ open class AkismetComment(val userIp: String, val userAgent: String) {
/**
* A string that describes the type of content being sent, such as:
*
* - [TYPE_COMMENT]
* - [TYPE_FORUM_POST]
* - [TYPE_REPLY]
* - [TYPE_BLOG_POST]
* - [TYPE_CONTACT_FORM]
* - [TYPE_SIGNUP]
* - [TYPE_MESSAGE]
* - [TYPE_PINGBACK]
* - [TYPE_TRACKBACK]
* - [TYPE_TWEET]
* - [CommentType.COMMENT]
* - [CommentType.FORUM_POST]
* - [CommentType.REPLY]
* - [CommentType.BLOG_POST]
* - [CommentType.CONTACT_FORM]
* - [CommentType.SIGNUP]
* - [CommentType.MESSAGE]
* - [CommentType.PINGBACK]
* - [CommentType.TRACKBACK]
* - [CommentType.TWEET]
*
* You may send a value not listed above if none of them accurately describe your content.
*
* This is further explained [here](http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/).
*/
var type: String? = ""
set(value) {
field = value.ifNull()
}
var type: CommentType = CommentType.NONE
/** Name submitted with the comment. */
/**
* Name submitted with the comment.
*/
var author: String? = ""
set(value) {
field = value.ifNull()
}
/** Email address submitted with the comment. */
/**
* Email address submitted with the comment.
*/
var authorEmail: String? = ""
set(value) {
field = value.ifNull()
}
/** URL submitted with comment. */
/**
* URL submitted with comment.
*/
var authorUrl: String? = ""
set(value) {
field = value.ifNull()
}
/** The content that was submitted. */
/**
* The content that was submitted.
*/
var content: String? = ""
set(value) {
field = value.ifNull()
@ -194,14 +175,16 @@ open class AkismetComment(val userIp: String, val userAgent: String) {
/**
* The user role of the user who submitted the comment. This is an optional parameter.
*
* If you set it to [ADMIN_ROLE], Akismet will always return false.
* If you set it to [ADMIN_ROLE], Akismet will always return `false`.
*/
var userRole: String? = ""
set(value) {
field = value.ifNull()
}
/** This is an optional parameter. You can use it when submitting test queries to Akismet. */
/**
* This is an optional parameter. You can use it when submitting test queries to Akismet.
*/
var isTest: Boolean = false
/**
@ -230,8 +213,7 @@ open class AkismetComment(val userIp: String, val userAgent: String) {
* Creates a new instance extracting the [userIp], [userAgent], [referrer] and [serverEnv] environment variables
* from a Servlet request.
*
* See the
* [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
* See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
*
* @see [serverEnv]
*/

40
src/main/kotlin/net/thauvin/erik/akismet/CommentConfig.kt
View file

@ -32,16 +32,6 @@
package net.thauvin.erik.akismet
import net.thauvin.erik.akismet.AkismetComment.Companion.ADMIN_ROLE
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_BLOG_POST
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_COMMENT
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_CONTACT_FORM
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_FORUM_POST
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_MESSAGE
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_PINGBACK
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_REPLY
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_SIGNUP
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TRACKBACK
import net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TWEET
/**
* Provides a comment configuration.
@ -54,7 +44,7 @@ class CommentConfig @JvmOverloads constructor(
var userAgent: String,
var referrer: String = "",
var permalink: String = "",
var type: String = "",
var type: CommentType = CommentType.NONE,
var author: String = "",
var authorEmail: String = "",
var authorUrl: String = "",
@ -96,7 +86,7 @@ class CommentConfig @JvmOverloads constructor(
data class Builder(var userIp: String, var userAgent: String) {
var referrer = ""
var permalink = ""
var type = ""
var type: CommentType = CommentType.NONE
var author = ""
var authorEmail = ""
var authorUrl = ""
@ -133,22 +123,22 @@ class CommentConfig @JvmOverloads constructor(
/**
* Sets a string that describes the type of content being sent, such as:
*
* - [TYPE_COMMENT]
* - [TYPE_FORUM_POST]
* - [TYPE_REPLY]
* - [TYPE_BLOG_POST]
* - [TYPE_CONTACT_FORM]
* - [TYPE_SIGNUP]
* - [TYPE_MESSAGE]
* - [TYPE_PINGBACK]
* - [TYPE_TRACKBACK]
* - [TYPE_TWEET]
* - [CommentType.COMMENT]
* - [CommentType.FORUM_POST]
* - [CommentType.REPLY]
* - [CommentType.BLOG_POST]
* - [CommentType.CONTACT_FORM]
* - [CommentType.SIGNUP]
* - [CommentType.MESSAGE]
* - [CommentType.PINGBACK]
* - [CommentType.TRACKBACK]
* - [CommentType.TWEET]
*
* You may send a value not listed above if none of them accurately describe your content.
*
* This is further explained [here](http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/).
*/
fun type(type: String): Builder = apply { this.type = type }
fun type(type: CommentType): Builder = apply { this.type = type }
/**
* Sets the mame submitted with the comment.
@ -184,7 +174,7 @@ class CommentConfig @JvmOverloads constructor(
*
* @see [Akismet.dateToGmt]
*/
fun postModifiedGmt(postModifiedGmt: String) = apply { this.postModifiedGmt = postModifiedGmt }
fun postModifiedGmt(postModifiedGmt: String): Builder = apply { this.postModifiedGmt = postModifiedGmt }
/**
* Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.
@ -201,7 +191,7 @@ class CommentConfig @JvmOverloads constructor(
/**
* Set the user role of the user who submitted the comment. This is an optional parameter.
*
* If you set it to [ADMIN_ROLE], Akismet will always return false.
* If you set it to [ADMIN_ROLE], Akismet will always return `false`.
*/
fun userRole(userRole: String): Builder = apply { this.userRole = userRole }

107
src/main/kotlin/net/thauvin/erik/akismet/CommentType.kt Normal file
View file

@ -0,0 +1,107 @@
/*
* CommentType.kt
*
* Copyright 2019-2024 Erik C. Thauvin (erik@thauvin.net)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of this project nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.akismet
import kotlinx.serialization.Serializable
/**
* Defines the comment types.
*/
@Serializable
data class CommentType(var value: String) {
companion object {
/**
* A blog comment.
*/
@JvmField
val COMMENT = CommentType("comment")
/**
* A top-level forum post.
*/
@JvmField
val FORUM_POST = CommentType("forum-post")
/**
* A reply to a top-level forum post.
*/
@JvmField
val REPLY = CommentType("reply")
/**
* A blog post.
*/
@JvmField
val BLOG_POST = CommentType("blog-post")
/**
* A contact form or feedback form submission.
*/
@JvmField
val CONTACT_FORM = CommentType("contact-form")
/** A new user account.
*/
@JvmField
val SIGNUP = CommentType("signup")
/**
* A message sent between just a few users.
*/
@JvmField
val MESSAGE = CommentType("message")
/**
* A pingback.
*/
@JvmField
val PINGBACK = CommentType("pingback")
/**
* A trackback.
*/
@JvmField
val TRACKBACK = CommentType("trackback")
/**
* A Twitter message.
*/
@JvmField
val TWEET = CommentType("tweet")
/**
* Undefined type.
*/
@JvmField
val NONE = CommentType("")
}
}

14
src/test/kotlin/net/thauvin/erik/akismet/AkismetTest.kt
View file

@ -169,7 +169,7 @@ class AkismetTest {
prop(AkismetComment::isTest).isFalse()
prop(AkismetComment::referrer).isEqualTo("")
prop(AkismetComment::permalink).isEqualTo("")
prop(AkismetComment::type).isEqualTo("")
prop(AkismetComment::type).isEqualTo(CommentType.NONE)
prop(AkismetComment::authorEmail).isEqualTo("")
prop(AkismetComment::author).isEqualTo("")
prop(AkismetComment::authorUrl).isEqualTo("")
@ -183,11 +183,11 @@ class AkismetTest {
prop(AkismetComment::serverEnv).size().isEqualTo(0)
}
with(empty) {
with(receiver = empty) {
for (s in listOf("test", "", null)) {
referrer = s
permalink = s
type = s
if (s != null) type = CommentType(s)
authorEmail = s
author = s
authorUrl = s
@ -204,7 +204,7 @@ class AkismetTest {
assertThat(empty, "AkismetComment($s)").all {
prop(AkismetComment::referrer).isEqualTo(expected)
prop(AkismetComment::permalink).isEqualTo(expected)
prop(AkismetComment::type).isEqualTo(expected)
prop(AkismetComment::type).isEqualTo(CommentType(expected))
prop(AkismetComment::authorEmail).isEqualTo(expected)
prop(AkismetComment::author).isEqualTo(expected)
prop(AkismetComment::authorUrl).isEqualTo(expected)
@ -384,7 +384,7 @@ class AkismetTest {
private val config = CommentConfig.Builder(comment.userIp, comment.userAgent)
.referrer(REFERER)
.permalink("http://yourblogdomainname.com/blog/post=1")
.type(AkismetComment.TYPE_COMMENT)
.type(CommentType.COMMENT)
.author("admin")
.authorEmail("test@test.com")
.authorUrl("http://www.CheckOutMyCoolSite.com")
@ -403,7 +403,7 @@ class AkismetTest {
with(comment) {
referrer = config.referrer
permalink = config.permalink
type = config.type
type = CommentType("comment")
author = config.author
authorEmail = config.authorEmail
authorUrl = config.authorUrl
@ -428,7 +428,7 @@ class AkismetTest {
postModifiedGmt = comment.dateGmt
blogLang = comment.blogLang
blogCharset = comment.blogCharset
userRole = comment.userRole
userRole = AkismetComment.ADMIN_ROLE
recheckReason = comment.recheckReason
isTest = true
}