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
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