From 156d85fee148a91d80e5bf86f6318896a8936b6d Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Fri, 24 May 2024 02:45:08 -0700 Subject: [PATCH] Updated docs --- .../-akismet-comment/-akismet-comment.html | 4 +- .../-companion/-a-d-m-i-n_-r-o-l-e.html | 2 +- .../-t-y-p-e_-b-l-o-g_-p-o-s-t.html | 2 +- .../-companion/-t-y-p-e_-c-o-m-m-e-n-t.html | 2 +- .../-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html | 2 +- .../-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html | 2 +- .../-companion/-t-y-p-e_-m-e-s-s-a-g-e.html | 2 +- .../-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html | 2 +- .../-companion/-t-y-p-e_-r-e-p-l-y.html | 2 +- .../-companion/-t-y-p-e_-s-i-g-n-u-p.html | 2 +- .../-t-y-p-e_-t-r-a-c-k-b-a-c-k.html | 2 +- .../-companion/-t-y-p-e_-t-w-e-e-t.html | 2 +- .../-akismet-comment/-companion/index.html | 2 +- .../-akismet-comment/author-email.html | 4 +- .../-akismet-comment/author-url.html | 4 +- .../-akismet-comment/author.html | 4 +- .../-akismet-comment/blog-charset.html | 4 +- .../-akismet-comment/blog-lang.html | 4 +- .../-akismet-comment/content.html | 4 +- .../-akismet-comment/date-gmt.html | 4 +- .../-akismet-comment/equals.html | 4 +- .../-akismet-comment/hash-code.html | 4 +- .../-akismet-comment/index.html | 44 +- .../-akismet-comment/is-test.html | 4 +- .../-akismet-comment/permalink.html | 4 +- .../-akismet-comment/post-modified-gmt.html | 4 +- .../-akismet-comment/recheck-reason.html | 4 +- .../-akismet-comment/referrer.html | 4 +- .../-akismet-comment/server-env.html | 4 +- .../-akismet-comment/to-json.html | 4 +- .../-akismet-comment/to-string.html | 4 +- .../-akismet-comment/type.html | 4 +- .../-akismet-comment/user-agent.html | 4 +- .../-akismet-comment/user-ip.html | 4 +- .../-akismet-comment/user-role.html | 4 +- .../-akismet/-akismet.html | 2 +- .../-akismet/-companion/date-to-gmt.html | 4 +- .../-akismet/-companion/index.html | 6 +- .../-akismet/-companion/json-comment.html | 4 +- .../-akismet/app-user-agent.html | 4 +- .../-akismet/blog.html | 4 +- .../-akismet/check-comment.html | 4 +- .../-akismet/debug-help.html | 4 +- .../-akismet/error-message.html | 4 +- .../-akismet/execute-method.html | 4 +- .../-akismet/http-status-code.html | 4 +- .../-akismet/index.html | 34 +- .../-akismet/is-discard.html | 4 +- .../-akismet/is-verified-key.html | 4 +- .../-akismet/logger.html | 4 +- .../-akismet/pro-tip.html | 4 +- .../-akismet/reset.html | 4 +- .../-akismet/response.html | 4 +- .../-akismet/submit-ham.html | 4 +- .../-akismet/submit-spam.html | 4 +- .../-akismet/verify-key.html | 4 +- .../-comment-config/-builder/-builder.html | 80 +++ .../-builder/author-email.html | 80 +++ .../-comment-config/-builder/author-url.html | 80 +++ .../-comment-config/-builder/author.html | 80 +++ .../-builder/blog-charset.html | 80 +++ .../-comment-config/-builder/blog-lang.html | 80 +++ .../-comment-config/-builder/build.html | 80 +++ .../-comment-config/-builder/content.html | 80 +++ .../-comment-config/-builder/date-gmt.html | 80 +++ .../-comment-config/-builder/index.html | 637 ++++++++++++++++++ .../-comment-config/-builder/is-test.html | 80 +++ .../-comment-config/-builder/permalink.html | 80 +++ .../-builder/post-modified-gmt.html | 80 +++ .../-builder/recheck-reason.html | 80 +++ .../-comment-config/-builder/referrer.html | 80 +++ .../-comment-config/-builder/server-env.html | 80 +++ .../-comment-config/-builder/type.html | 80 +++ .../-comment-config/-builder/user-agent.html | 80 +++ .../-comment-config/-builder/user-ip.html | 80 +++ .../-comment-config/-builder/user-role.html | 80 +++ .../-comment-config/-comment-config.html | 80 +++ .../-comment-config/author-email.html | 80 +++ .../-comment-config/author-url.html | 80 +++ .../-comment-config/author.html | 80 +++ .../-comment-config/blog-charset.html | 80 +++ .../-comment-config/blog-lang.html | 80 +++ .../-comment-config/content.html | 80 +++ .../-comment-config/date-gmt.html | 80 +++ .../-comment-config/index.html | 382 +++++++++++ .../-comment-config/is-test.html | 80 +++ .../-comment-config/permalink.html | 80 +++ .../-comment-config/post-modified-gmt.html | 80 +++ .../-comment-config/recheck-reason.html | 80 +++ .../-comment-config/referrer.html | 80 +++ .../-comment-config/server-env.html | 80 +++ .../-comment-config/type.html | 80 +++ .../-comment-config/user-agent.html | 80 +++ .../-comment-config/user-ip.html | 80 +++ .../-comment-config/user-role.html | 80 +++ .../net.thauvin.erik.akismet/index.html | 17 +- docs/-akismet -kotlin/package-list | 58 ++ docs/images/homepage.svg | 3 + docs/index.html | 2 +- docs/navigation.html | 6 + docs/scripts/pages.json | 2 +- docs/scripts/platform-content-handler.js | 45 +- docs/styles/main.css | 2 +- docs/styles/style.css | 68 +- 104 files changed, 4271 insertions(+), 181 deletions(-) create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html create mode 100644 docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html create mode 100644 docs/images/homepage.svg diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html index 3013bd1..7c95c93 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html @@ -66,10 +66,10 @@

AkismetComment

-
constructor(request: <Error class: unknown class>)(source)

Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.

See the Akismet API for more details.

See also

constructor(userIp: String, userAgent: String)(source)

Creates a new instance.

See the Akismet API for more details.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

+
constructor(request: <Error class: unknown class>)(source)

Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.

See the Akismet API for more details.

See also

constructor(config: CommentConfig)(source)

constructor(userIp: String, userAgent: String)(source)

Creates a new instance.

See the Akismet API for more details.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html index 66a74d9..d034a3f 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html @@ -69,7 +69,7 @@
const val ADMIN_ROLE: String(source)

Administrator role. If used, Akismet will always return false.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html index 5968791..7355fc7 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html @@ -69,7 +69,7 @@
const val TYPE_BLOG_POST: String(source)

A blog post.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html index 9df75a7..afe8804 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html @@ -69,7 +69,7 @@
const val TYPE_COMMENT: String(source)

A blog comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html index c6d715d..8b621e3 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html @@ -69,7 +69,7 @@
const val TYPE_CONTACT_FORM: String(source)

A contact form or feedback form submission.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html index e7affbe..904d5ab 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html @@ -69,7 +69,7 @@
const val TYPE_FORUM_POST: String(source)

A top-level forum post.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html index c9e30ef..6eebb27 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html @@ -69,7 +69,7 @@
const val TYPE_MESSAGE: String(source)

A message sent between just a few users.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html index 978e89b..88d4c32 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html @@ -69,7 +69,7 @@
const val TYPE_PINGBACK: String(source)

A pingback.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html index 546c9e7..27d019e 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html @@ -69,7 +69,7 @@
const val TYPE_REPLY: String(source)

A reply to a top-level forum post.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html index 23556f1..ffbd0fe 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html @@ -69,7 +69,7 @@
const val TYPE_SIGNUP: String(source)

A new user account.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html index 0eed509..5cf4269 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html @@ -69,7 +69,7 @@
const val TYPE_TRACKBACK: String(source)

A trackback.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html index 3c1f811..6d6a965 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html @@ -69,7 +69,7 @@
const val TYPE_TWEET: String(source)

A Twitter message.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html index 66d5f6f..fa7d536 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html @@ -243,7 +243,7 @@
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html index 32b3e8e..7a99041 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html @@ -66,10 +66,10 @@

authorEmail

-
var authorEmail: String?(source)

Email address submitted with the comment.

+
var authorEmail: String?(source)

Email address submitted with the comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html index b4eaa89..3c7bb0b 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html @@ -66,10 +66,10 @@

authorUrl

-
var authorUrl: String?(source)

URL submitted with comment.

+
var authorUrl: String?(source)

URL submitted with comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html index b483d03..fbf6f8b 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html @@ -66,10 +66,10 @@

author

-
var author: String?(source)

Name submitted with the comment.

+
var author: String?(source)

Name submitted with the comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html index 5bf0ffc..e41952e 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html @@ -66,10 +66,10 @@

blogCharset

-
var blogCharset: String?(source)

The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

+
var blogCharset: String?(source)

The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html index 23a222b..408401c 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html @@ -66,10 +66,10 @@

blogLang

-
var blogLang: String?(source)

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

A site with articles in English and French might use: en, fr_ca

+
var blogLang: String?(source)

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

A site with articles in English and French might use: en, fr_ca

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html index b0a64a8..f61a684 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html @@ -66,10 +66,10 @@

content

-
var content: String?(source)

The content that was submitted.

+
var content: String?(source)

The content that was submitted.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html index 9a963db..332a620 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html @@ -66,10 +66,10 @@

dateGmt

-
var dateGmt: String?(source)

The UTC timestamp of the creation of the comment, in ISO 8601 format.

May be omitted if the comment is sent to the API at the time it is created.

See also

+
var dateGmt: String?(source)

The UTC timestamp of the creation of the comment, in ISO 8601 format.

May be omitted if the comment is sent to the API at the time it is created.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html index 7b22c2a..e4cde43 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html @@ -66,10 +66,10 @@

equals

-
open operator override fun equals(other: Any?): Boolean(source)

Indicates whether some other object is equal to this one.

+
open operator override fun equals(other: Any?): Boolean(source)

Indicates whether some other object is equal to this one.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html index 2fd48d0..590c660 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html @@ -66,10 +66,10 @@

hashCode

-
open override fun hashCode(): Int(source)

Returns a hash code value for the object.

+
open override fun hashCode(): Int(source)

Returns a hash code value for the object.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html index bc05111..d7f79e9 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html @@ -72,17 +72,17 @@

Constructors

-
+
- +
Link copied to clipboard
-
constructor(request: <Error class: unknown class>)

Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.

constructor(userIp: String, userAgent: String)

Creates a new instance.

+
constructor(request: <Error class: unknown class>)

Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.

constructor(config: CommentConfig)
constructor(userIp: String, userAgent: String)

Creates a new instance.

@@ -120,7 +120,7 @@
-
var author: String?

Name submitted with the comment.

+
var author: String?

Name submitted with the comment.

@@ -135,7 +135,7 @@
-
var authorEmail: String?

Email address submitted with the comment.

+
var authorEmail: String?

Email address submitted with the comment.

@@ -150,7 +150,7 @@
-
var authorUrl: String?

URL submitted with comment.

+
var authorUrl: String?

URL submitted with comment.

@@ -165,7 +165,7 @@
-
var blogCharset: String?

The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

+
var blogCharset: String?

The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

@@ -180,7 +180,7 @@
-
var blogLang: String?

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

+
var blogLang: String?

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

@@ -195,7 +195,7 @@
-
var content: String?

The content that was submitted.

+
var content: String?

The content that was submitted.

@@ -210,7 +210,7 @@
-
var dateGmt: String?

The UTC timestamp of the creation of the comment, in ISO 8601 format.

+
var dateGmt: String?

The UTC timestamp of the creation of the comment, in ISO 8601 format.

@@ -225,7 +225,7 @@
-
var isTest: Boolean

This is an optional parameter. You can use it when submitting test queries to Akismet.

+
var isTest: Boolean

This is an optional parameter. You can use it when submitting test queries to Akismet.

@@ -240,7 +240,7 @@
-
var permalink: String?

The full permanent URL of the entry the comment was submitted to.

+
var permalink: String?

The full permanent URL of the entry the comment was submitted to.

@@ -255,7 +255,7 @@
-
var postModifiedGmt: String?

The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

+
var postModifiedGmt: String?

The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

@@ -270,7 +270,7 @@
-
var recheckReason: String?

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.

+
var recheckReason: String?

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.

@@ -285,7 +285,7 @@
-
var referrer: String?

The content of the referer header should be set here.

+
var referrer: String?

The content of the referer header should be set here.

@@ -300,7 +300,7 @@
-
var serverEnv: Map<String, String>

In PHP, there is an array of environmental variables called $_SERVER 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.

+
var serverEnv: Map<String, String>

In PHP, there is an array of environmental variables called $_SERVER 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.

@@ -315,7 +315,7 @@
-
var type: String?

A string that describes the type of content being sent, such as:

+
var type: String?

A string that describes the type of content being sent, such as:

@@ -330,7 +330,7 @@
-
val userAgent: String
+
val userAgent: String
@@ -345,7 +345,7 @@
-
val userIp: String
+
val userIp: String
@@ -360,7 +360,7 @@
-
var userRole: String?

The user role of the user who submitted the comment. This is an optional parameter.

+
var userRole: String?

The user role of the user who submitted the comment. This is an optional parameter.

@@ -409,7 +409,7 @@
-
fun toJson(): String

Returns a JSON representation of the comment.

+
fun toJson(): String

Returns a JSON representation of the comment.

@@ -435,7 +435,7 @@
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html index 58cc1e9..ef61f6e 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html @@ -66,10 +66,10 @@

isTest

-
var isTest: Boolean(source)

This is an optional parameter. You can use it when submitting test queries to Akismet.

+
var isTest: Boolean(source)

This is an optional parameter. You can use it when submitting test queries to Akismet.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html index ae5f2b4..b4d9093 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html @@ -66,10 +66,10 @@

permalink

-
var permalink: String?(source)

The full permanent URL of the entry the comment was submitted to.

+
var permalink: String?(source)

The full permanent URL of the entry the comment was submitted to.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html index 2a322f3..d1bb3c7 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html @@ -66,10 +66,10 @@

postModifiedGmt

-
var postModifiedGmt: String?(source)

The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

See also

+
var postModifiedGmt: String?(source)

The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html index 45a2265..77a4f0e 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html @@ -66,10 +66,10 @@

recheckReason

-
var recheckReason: String?(source)

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.

For example: edit

+
var recheckReason: String?(source)

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.

For example: edit

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html index 426839f..2efc507 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html @@ -66,10 +66,10 @@

referrer

-
var referrer: String?(source)

The content of the referer header should be set here.

+
var referrer: String?(source)

The content of the referer header should be set here.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html index e850422..12d306d 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html @@ -66,10 +66,10 @@

serverEnv

-
var serverEnv: Map<String, String>(source)

In PHP, there is an array of environmental variables called $_SERVER 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.

How the submitted content interacts with the server can be very telling, so please include as much of it as possible.

+
var serverEnv: Map<String, String>(source)

In PHP, there is an array of environmental variables called $_SERVER 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.

How the submitted content interacts with the server can be very telling, so please include as much of it as possible.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html index 3345ebe..87190b6 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html @@ -66,10 +66,10 @@

toJson

-
fun toJson(): String(source)

Returns a JSON representation of the comment.

See also

+
fun toJson(): String(source)

Returns a JSON representation of the comment.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html index d2628b4..98e8082 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html @@ -66,10 +66,10 @@

toString

-
open override fun toString(): String(source)

Returns a JSON representation of the comment.

See also

+
open override fun toString(): String(source)

Returns a JSON representation of the comment.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html index a067ff5..fa164f7 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html @@ -66,10 +66,10 @@

type

-
var type: String?(source)

A string that describes the type of content being sent, such as:

You may send a value not listed above if none of them accurately describe your content.

This is further explained here.

+
var type: String?(source)

A string that describes the type of content being sent, such as:

You may send a value not listed above if none of them accurately describe your content.

This is further explained here.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html index 1ce0772..425c8e0 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html @@ -66,10 +66,10 @@

userAgent

-
val userAgent: String(source)

Parameters

userAgent

User agent string of the web browser submitting the comment.

+
val userAgent: String(source)

Parameters

userAgent

User agent string of the web browser submitting the comment.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html index 2b9bfbc..382ca42 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html @@ -66,10 +66,10 @@

userIp

-
val userIp: String(source)

Parameters

userIp

IP address of the comment submitter.

+
val userIp: String(source)

Parameters

userIp

IP address of the comment submitter.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html index 8ae0f29..6fbc2a1 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html @@ -66,10 +66,10 @@

userRole

-
var userRole: String?(source)

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.

+
var userRole: String?(source)

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.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html index d65404f..6c96d10 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html @@ -69,7 +69,7 @@
constructor(apiKey: String, blog: String)(source)

Creates a new instance using an Akismet API key and URL registered with Akismet.

constructor(apiKey: String)(source)

Creates a new instance using the provided Akismet API key.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html index f7a9122..12ebc0b 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html @@ -66,10 +66,10 @@

dateToGmt

-
fun dateToGmt(date: Date): String(source)

Converts a date to a UTC timestamp. (ISO 8601)

See also

fun dateToGmt(date: LocalDateTime): String(source)

Converts a locale date/time to a UTC timestamp. (ISO 8601)

See also

+
fun dateToGmt(date: Date): String(source)

Converts a date to a UTC timestamp. (ISO 8601)

See also

fun dateToGmt(date: LocalDateTime): String(source)

Converts a locale date/time to a UTC timestamp. (ISO 8601)

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html index 03314eb..15cb77a 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html @@ -82,7 +82,7 @@
-
fun dateToGmt(date: LocalDateTime): String

Converts a locale date/time to a UTC timestamp. (ISO 8601)

fun dateToGmt(date: Date): String

Converts a date to a UTC timestamp. (ISO 8601)

+
fun dateToGmt(date: LocalDateTime): String

Converts a locale date/time to a UTC timestamp. (ISO 8601)

fun dateToGmt(date: Date): String

Converts a date to a UTC timestamp. (ISO 8601)

@@ -97,7 +97,7 @@
-
fun jsonComment(json: String): AkismetComment

(Re)Creates a comment from a JSON string.

+
fun jsonComment(json: String): AkismetComment

(Re)Creates a comment from a JSON string.

@@ -108,7 +108,7 @@
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html index eeb9e5d..4899569 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html @@ -66,10 +66,10 @@

jsonComment

-
fun jsonComment(json: String): AkismetComment(source)

(Re)Creates a comment from a JSON string.

See also

+
fun jsonComment(json: String): AkismetComment(source)

(Re)Creates a comment from a JSON string.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html index c88ec98..2af3726 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html @@ -66,10 +66,10 @@

appUserAgent

-
var appUserAgent: String(source)

The application user agent to be sent to Akismet.

If possible, the application user agent string should always use the following format:

    Application Name/Version
Content copied to clipboard

The library's own user agent string will automatically be appended.

See the Akismet API for more details.

+
var appUserAgent: String(source)

The application user agent to be sent to Akismet.

If possible, the application user agent string should always use the following format:

    Application Name/Version
Content copied to clipboard

The library's own user agent string will automatically be appended.

See the Akismet API for more details.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html index 0da56d6..16c3896 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html @@ -66,10 +66,10 @@

blog

-
var blog: String(source)

The URL registered with Akismet.

+
var blog: String(source)

The URL registered with Akismet.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html index 12364f2..51c4b63 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html @@ -66,10 +66,10 @@

checkComment

-
fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean(source)

Comment Check.

This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data

By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return false and log the error, use the trueOnError parameter to change this behavior.

See the Akismet API for more details.

Return

true if the comment is spam, false if the comment is not.

Parameters

trueOnError

Set to return true on error.

+
fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean(source)

Comment Check.

This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data

By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return false and log the error, use the trueOnError parameter to change this behavior.

See the Akismet API for more details.

Return

true if the comment is spam, false if the comment is not.

Parameters

trueOnError

Set to return true on error.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html index b0d819a..662ecd8 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html @@ -66,10 +66,10 @@

debugHelp

-
var debugHelp: String(source)

The x-akismet-debug-help header from the last operation, if any.

If the call returns neither true nor false, the x-akismet-debug-help header will provide context for any error that has occurred.

Note that the x-akismet-debug-help header will not always be sent if a response does not return false or true.

See the Akismet API for more details.

+
var debugHelp: String(source)

The x-akismet-debug-help header from the last operation, if any.

If the call returns neither true nor false, the x-akismet-debug-help header will provide context for any error that has occurred.

Note that the x-akismet-debug-help header will not always be sent if a response does not return false or true.

See the Akismet API for more details.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html index 072beab..7ebd106 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html @@ -66,10 +66,10 @@

errorMessage

-
var errorMessage: String(source)

The error message.

The error (IO, empty response from Akismet, etc.) message is also logged as a warning.

See also

+
var errorMessage: String(source)

The error message.

The error (IO, empty response from Akismet, etc.) message is also logged as a warning.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html index 9917361..6864594 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html @@ -66,10 +66,10 @@

executeMethod

-
fun executeMethod(apiUrl: <Error class: unknown class>, formBody: <Error class: unknown class>, trueOnError: Boolean = false): Boolean(source)

Executes a call to an Akismet REST API method.

Parameters

apiUrl

The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)

formBody

The HTTP POST form body containing the request parameters to be submitted.

trueOnError

Set to return true on error (IO, empty response, etc.)

+
fun executeMethod(apiUrl: <Error class: unknown class>, formBody: <Error class: unknown class>, trueOnError: Boolean = false): Boolean(source)

Executes a call to an Akismet REST API method.

Parameters

apiUrl

The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)

formBody

The HTTP POST form body containing the request parameters to be submitted.

trueOnError

Set to return true on error (IO, empty response, etc.)

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html index 4f00cdf..ef6eb2d 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html @@ -66,10 +66,10 @@

httpStatusCode

-
var httpStatusCode: Int(source)

The HTTP status code of the last operation.

+
var httpStatusCode: Int(source)

The HTTP status code of the last operation.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html index 2b797a4..ecd5030 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html @@ -120,7 +120,7 @@
-
var appUserAgent: String

The application user agent to be sent to Akismet.

+
var appUserAgent: String

The application user agent to be sent to Akismet.

@@ -135,7 +135,7 @@
-
var blog: String

The URL registered with Akismet.

+
var blog: String

The URL registered with Akismet.

@@ -150,7 +150,7 @@
-
var debugHelp: String

The x-akismet-debug-help header from the last operation, if any.

+
var debugHelp: String

The x-akismet-debug-help header from the last operation, if any.

@@ -165,7 +165,7 @@
-
var errorMessage: String

The error message.

+
var errorMessage: String

The error message.

@@ -180,7 +180,7 @@
-
var httpStatusCode: Int

The HTTP status code of the last operation.

+
var httpStatusCode: Int

The HTTP status code of the last operation.

@@ -195,7 +195,7 @@
-
var isDiscard: Boolean

Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.

+
var isDiscard: Boolean

Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.

@@ -210,7 +210,7 @@
-
var isVerifiedKey: Boolean

Set to true if the API Key has been verified.

+
var isVerifiedKey: Boolean

Set to true if the API Key has been verified.

@@ -225,7 +225,7 @@
-
val logger: Logger

The logger instance.

+
val logger: Logger

The logger instance.

@@ -240,7 +240,7 @@
-
var proTip: String

The x-akismet-pro-tip header from the last operation, if any.

+
var proTip: String

The x-akismet-pro-tip header from the last operation, if any.

@@ -255,7 +255,7 @@
-
var response: String

The actual response sent by Akismet from the last operation.

+
var response: String

The actual response sent by Akismet from the last operation.

@@ -274,7 +274,7 @@
-
fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean

Comment Check.

+
fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean

Comment Check.

@@ -289,7 +289,7 @@
-
fun executeMethod(apiUrl: <Error class: unknown class>, formBody: <Error class: unknown class>, trueOnError: Boolean = false): Boolean

Executes a call to an Akismet REST API method.

+
fun executeMethod(apiUrl: <Error class: unknown class>, formBody: <Error class: unknown class>, trueOnError: Boolean = false): Boolean

Executes a call to an Akismet REST API method.

@@ -304,7 +304,7 @@
-
fun reset()

Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.

+
fun reset()

Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.

@@ -319,7 +319,7 @@
-
fun submitHam(comment: AkismetComment): Boolean

Submit Ham. (False Positives)

+
fun submitHam(comment: AkismetComment): Boolean

Submit Ham. (False Positives)

@@ -334,7 +334,7 @@
-
fun submitSpam(comment: AkismetComment): Boolean

Submit Spam. (Missed Spam)

+
fun submitSpam(comment: AkismetComment): Boolean

Submit Spam. (Missed Spam)

@@ -349,7 +349,7 @@
-
fun verifyKey(): Boolean

Key Verification.

+
fun verifyKey(): Boolean

Key Verification.

@@ -360,7 +360,7 @@
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html index ae2d654..7432915 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html @@ -66,10 +66,10 @@

isDiscard

-
var isDiscard: Boolean(source)

Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.

See the Akismet API for more details.

See also

+
var isDiscard: Boolean(source)

Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.

See the Akismet API for more details.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html index 1030676..63bd9ed 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html @@ -66,10 +66,10 @@

isVerifiedKey

-
var isVerifiedKey: Boolean(source)

Set to true if the API Key has been verified.

See also

+
var isVerifiedKey: Boolean(source)

Set to true if the API Key has been verified.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html index 1ab7294..4a22835 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html @@ -66,10 +66,10 @@

logger

-
val logger: Logger(source)

The logger instance.

+
val logger: Logger(source)

The logger instance.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html index 04647a8..d84c664 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html @@ -66,10 +66,10 @@

proTip

-
var proTip: String(source)

The x-akismet-pro-tip header from the last operation, if any.

If the x-akismet-pro-tip header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.

See the Akismet API for more details.

See also

+
var proTip: String(source)

The x-akismet-pro-tip header from the last operation, if any.

If the x-akismet-pro-tip header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.

See the Akismet API for more details.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html index aa0b1cc..89b0d83 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html @@ -66,10 +66,10 @@

reset

-
fun reset()(source)

Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.

+
fun reset()(source)

Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html index 9c21ba0..441f1d3 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html @@ -66,10 +66,10 @@

response

-
var response: String(source)

The actual response sent by Akismet from the last operation.

For example: true, false, valid, invalid, etc.

+
var response: String(source)

The actual response sent by Akismet from the last operation.

For example: true, false, valid, invalid, etc.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html index 0c1b658..fd3d7a4 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html @@ -66,10 +66,10 @@

submitHam

-
fun submitHam(comment: AkismetComment): Boolean(source)

Submit Ham. (False Positives)

This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as comment check and submit spam.

It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.

See the Akismet API for more details.

Return

true if the comment was submitted, false otherwise.

+
fun submitHam(comment: AkismetComment): Boolean(source)

Submit Ham. (False Positives)

This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as comment check and submit spam.

It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.

See the Akismet API for more details.

Return

true if the comment was submitted, false otherwise.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html index 22d568e..0ee0cc5 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html @@ -66,10 +66,10 @@

submitSpam

-
fun submitSpam(comment: AkismetComment): Boolean(source)

Submit Spam. (Missed Spam)

This call is for submitting comments that weren't marked as spam but should have been.

It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.

See the Akismet API for more details.

Return

true if the comment was submitted, false otherwise.

+
fun submitSpam(comment: AkismetComment): Boolean(source)

Submit Spam. (Missed Spam)

This call is for submitting comments that weren't marked as spam but should have been.

It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.

See the Akismet API for more details.

Return

true if the comment was submitted, false otherwise.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html index 9272ecd..b59bdb6 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html @@ -66,10 +66,10 @@

verifyKey

-
fun verifyKey(): Boolean(source)

Key Verification.

Key verification authenticates your key before calling the comment check, submit spam, or submit ham methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.

See the Akismet API for more details.

Return

true if the key is valid, false otherwise.

See also

+
fun verifyKey(): Boolean(source)

Key Verification.

Key verification authenticates your key before calling the comment check, submit spam, or submit ham methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.

See the Akismet API for more details.

Return

true if the key is valid, false otherwise.

See also

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html new file mode 100644 index 0000000..fd78ecf --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/Builder
+
+

Builder

+
+
constructor(userIp: String, userAgent: String)(source)

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html new file mode 100644 index 0000000..37a811e --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html @@ -0,0 +1,80 @@ + + + + + authorEmail + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/authorEmail
+
+

authorEmail

+
+
fun authorEmail(authorEmail: String): CommentConfig.Builder(source)

Sets the email address submitted with the comment.

var authorEmail: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html new file mode 100644 index 0000000..39880c6 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html @@ -0,0 +1,80 @@ + + + + + authorUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/authorUrl
+
+

authorUrl

+
+
fun authorUrl(authorUrl: String): CommentConfig.Builder(source)

Sets the URL submitted with comment.

var authorUrl: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html new file mode 100644 index 0000000..553d17b --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html @@ -0,0 +1,80 @@ + + + + + author + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/author
+
+

author

+
+
fun author(author: String): CommentConfig.Builder(source)

Sets the mame submitted with the comment.

var author: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html new file mode 100644 index 0000000..f6eba16 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html @@ -0,0 +1,80 @@ + + + + + blogCharset + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/blogCharset
+
+

blogCharset

+
+
fun blogCharset(blogCharset: String): CommentConfig.Builder(source)

Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

var blogCharset: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html new file mode 100644 index 0000000..c9820b0 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html @@ -0,0 +1,80 @@ + + + + + blogLang + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/blogLang
+
+

blogLang

+
+
fun blogLang(blogLang: String): CommentConfig.Builder(source)

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

A site with articles in English and French might use: en, fr_ca

var blogLang: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html new file mode 100644 index 0000000..4846b23 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/build
+
+

build

+
+
fun build(): CommentConfig(source)

Builds a new comment configuration.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html new file mode 100644 index 0000000..ab0641a --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html @@ -0,0 +1,80 @@ + + + + + content + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/content
+
+

content

+
+
fun content(content: String): CommentConfig.Builder(source)

Sets the content that was submitted.

var content: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html new file mode 100644 index 0000000..50cb95f --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html @@ -0,0 +1,80 @@ + + + + + dateGmt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/dateGmt
+
+

dateGmt

+
+
fun dateGmt(dateGmt: String): CommentConfig.Builder(source)

Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.

May be omitted if the comment is sent to the API at the time it is created.

See also

var dateGmt: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html new file mode 100644 index 0000000..6989807 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html @@ -0,0 +1,637 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder
+
+

Builder

+
data class Builder(var userIp: String, var userAgent: String)(source)

Provides a configuration builder.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(userIp: String, userAgent: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var author: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var authorEmail: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var authorUrl: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var blogCharset: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var blogLang: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var content: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var dateGmt: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var isTest: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var permalink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var postModifiedGmt: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var recheckReason: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var referrer: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var serverEnv: Map<String, String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var type: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userAgent: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userIp: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userRole: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun author(author: String): CommentConfig.Builder

Sets the mame submitted with the comment.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun authorEmail(authorEmail: String): CommentConfig.Builder

Sets the email address submitted with the comment.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun authorUrl(authorUrl: String): CommentConfig.Builder

Sets the URL submitted with comment.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun blogCharset(blogCharset: String): CommentConfig.Builder

Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun blogLang(blogLang: String): CommentConfig.Builder

Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): CommentConfig

Builds a new comment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun content(content: String): CommentConfig.Builder

Sets the content that was submitted.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun dateGmt(dateGmt: String): CommentConfig.Builder

Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun isTest(isTest: Boolean): CommentConfig.Builder

This is optional. You can set it when submitting test queries to Akismet.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun permalink(permalink: String): CommentConfig.Builder

Sets the full permanent URL of the entry the comment was submitted to.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun postModifiedGmt(postModifiedGmt: String): <Error class: unknown class>

Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun recheckReason(checkReason: String): CommentConfig.Builder

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun referrer(referrer: String): CommentConfig.Builder

Sets the content of the referrer header.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun serverEnv(serverEnv: Map<String, String>): CommentConfig.Builder

In PHP, there is an array of environmental variables called $_SERVER 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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun type(type: String): CommentConfig.Builder

Sets a string that describes the type of content being sent, such as:

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun userAgent(userAgent: String): CommentConfig.Builder

Sets the user agent string of the web browser submitting the comment.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun userIp(userIp: String): CommentConfig.Builder

Sets the IP address of the comment submitter.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun userRole(userRole: String): CommentConfig.Builder

Set the user role of the user who submitted the comment. This is an optional parameter.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html new file mode 100644 index 0000000..4cfd974 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html @@ -0,0 +1,80 @@ + + + + + isTest + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/isTest
+
+

isTest

+
+
fun isTest(isTest: Boolean): CommentConfig.Builder(source)

This is optional. You can set it when submitting test queries to Akismet.

var isTest: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html new file mode 100644 index 0000000..7e5089b --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html @@ -0,0 +1,80 @@ + + + + + permalink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/permalink
+
+

permalink

+
+
fun permalink(permalink: String): CommentConfig.Builder(source)

Sets the full permanent URL of the entry the comment was submitted to.

var permalink: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html new file mode 100644 index 0000000..d2103fa --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html @@ -0,0 +1,80 @@ + + + + + postModifiedGmt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/postModifiedGmt
+
+

postModifiedGmt

+
+
fun postModifiedGmt(postModifiedGmt: String): <Error class: unknown class>(source)

Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.

See also

var postModifiedGmt: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html new file mode 100644 index 0000000..ed9266f --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html @@ -0,0 +1,80 @@ + + + + + recheckReason + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/recheckReason
+
+

recheckReason

+
+
fun recheckReason(checkReason: String): CommentConfig.Builder(source)

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.

For example: edit

var recheckReason: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html new file mode 100644 index 0000000..1687d92 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html @@ -0,0 +1,80 @@ + + + + + referrer + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/referrer
+
+

referrer

+
+
fun referrer(referrer: String): CommentConfig.Builder(source)

Sets the content of the referrer header.

var referrer: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html new file mode 100644 index 0000000..4fe2379 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html @@ -0,0 +1,80 @@ + + + + + serverEnv + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/serverEnv
+
+

serverEnv

+
+
fun serverEnv(serverEnv: Map<String, String>): CommentConfig.Builder(source)

In PHP, there is an array of environmental variables called $_SERVER 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.

How the submitted content interacts with the server can be very telling, so please include as much of it as possible.

var serverEnv: Map<String, String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html new file mode 100644 index 0000000..1223c05 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/type
+
+

type

+
+
fun type(type: String): CommentConfig.Builder(source)

Sets a string that describes the type of content being sent, such as:

You may send a value not listed above if none of them accurately describe your content.

This is further explained here.

var type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html new file mode 100644 index 0000000..ebe0b60 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html @@ -0,0 +1,80 @@ + + + + + userAgent + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/userAgent
+
+

userAgent

+
+
fun userAgent(userAgent: String): CommentConfig.Builder(source)

Sets the user agent string of the web browser submitting the comment.

var userAgent: String(source)

Parameters

userAgent

User agent string of the web browser submitting the comment.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html new file mode 100644 index 0000000..f2b7151 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html @@ -0,0 +1,80 @@ + + + + + userIp + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/userIp
+
+

userIp

+
+
fun userIp(userIp: String): CommentConfig.Builder(source)

Sets the IP address of the comment submitter.

var userIp: String(source)

Parameters

userIp

IP address of the comment submitter.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html new file mode 100644 index 0000000..53891ca --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html @@ -0,0 +1,80 @@ + + + + + userRole + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/Builder/userRole
+
+

userRole

+
+
fun userRole(userRole: String): CommentConfig.Builder(source)

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.

var userRole: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html new file mode 100644 index 0000000..d3106ab --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html @@ -0,0 +1,80 @@ + + + + + CommentConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/CommentConfig
+
+

CommentConfig

+
+
constructor(builder: CommentConfig.Builder)(source)

constructor(userIp: String, userAgent: String, referrer: String = "", permalink: String = "", type: String = "", author: String = "", authorEmail: String = "", authorUrl: String = "", content: String = "", dateGmt: String = "", postModifiedGmt: String = "", blogLang: String = "", blogCharset: String = "", userRole: String = "", isTest: Boolean = false, recheckReason: String = "", serverEnv: Map<String, String> = emptyMap())(source)

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html new file mode 100644 index 0000000..f929016 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html @@ -0,0 +1,80 @@ + + + + + authorEmail + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/authorEmail
+
+

authorEmail

+
+
var authorEmail: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html new file mode 100644 index 0000000..b68ae93 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html @@ -0,0 +1,80 @@ + + + + + authorUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/authorUrl
+
+

authorUrl

+
+
var authorUrl: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html new file mode 100644 index 0000000..4dddd46 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html @@ -0,0 +1,80 @@ + + + + + author + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/author
+
+

author

+
+
var author: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html new file mode 100644 index 0000000..e461179 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html @@ -0,0 +1,80 @@ + + + + + blogCharset + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/blogCharset
+
+

blogCharset

+
+
var blogCharset: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html new file mode 100644 index 0000000..2cabbb2 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html @@ -0,0 +1,80 @@ + + + + + blogLang + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/blogLang
+
+

blogLang

+
+
var blogLang: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html new file mode 100644 index 0000000..47f76d7 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html @@ -0,0 +1,80 @@ + + + + + content + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/content
+
+

content

+
+
var content: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html new file mode 100644 index 0000000..4fa14cb --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html @@ -0,0 +1,80 @@ + + + + + dateGmt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/dateGmt
+
+

dateGmt

+
+
var dateGmt: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html new file mode 100644 index 0000000..6a4ceaf --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html @@ -0,0 +1,382 @@ + + + + + CommentConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig
+
+

CommentConfig

+
class CommentConfig constructor(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<String, String> = emptyMap())(source)

Provides a comment configuration.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(builder: CommentConfig.Builder)
constructor(userIp: String, userAgent: String, referrer: String = "", permalink: String = "", type: String = "", author: String = "", authorEmail: String = "", authorUrl: String = "", content: String = "", dateGmt: String = "", postModifiedGmt: String = "", blogLang: String = "", blogCharset: String = "", userRole: String = "", isTest: Boolean = false, recheckReason: String = "", serverEnv: Map<String, String> = emptyMap())
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(var userIp: String, var userAgent: String)

Provides a configuration builder.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var author: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var authorEmail: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var authorUrl: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var blogCharset: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var blogLang: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var content: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var dateGmt: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var isTest: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var permalink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var postModifiedGmt: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var recheckReason: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var referrer: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var serverEnv: Map<String, String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var type: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userAgent: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userIp: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var userRole: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html new file mode 100644 index 0000000..6268169 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html @@ -0,0 +1,80 @@ + + + + + isTest + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/isTest
+
+

isTest

+
+
var isTest: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html new file mode 100644 index 0000000..71ced0d --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html @@ -0,0 +1,80 @@ + + + + + permalink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/permalink
+
+

permalink

+
+
var permalink: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html new file mode 100644 index 0000000..5c5b107 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html @@ -0,0 +1,80 @@ + + + + + postModifiedGmt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/postModifiedGmt
+
+

postModifiedGmt

+
+
var postModifiedGmt: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html new file mode 100644 index 0000000..7c47420 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html @@ -0,0 +1,80 @@ + + + + + recheckReason + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/recheckReason
+
+

recheckReason

+
+
var recheckReason: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html new file mode 100644 index 0000000..4b72c35 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html @@ -0,0 +1,80 @@ + + + + + referrer + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/referrer
+
+

referrer

+
+
var referrer: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html new file mode 100644 index 0000000..56a04ef --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html @@ -0,0 +1,80 @@ + + + + + serverEnv + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/serverEnv
+
+

serverEnv

+
+
var serverEnv: Map<String, String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html new file mode 100644 index 0000000..f9e6853 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/type
+
+

type

+
+
var type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html new file mode 100644 index 0000000..3fe2c97 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html @@ -0,0 +1,80 @@ + + + + + userAgent + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/userAgent
+
+

userAgent

+
+
var userAgent: String(source)

Parameters

userAgent

User agent string of the web browser submitting the comment.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html new file mode 100644 index 0000000..6505d24 --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html @@ -0,0 +1,80 @@ + + + + + userIp + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/userIp
+
+

userIp

+
+
var userIp: String(source)

Parameters

userIp

IP address of the comment submitter.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html new file mode 100644 index 0000000..4f5faac --- /dev/null +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html @@ -0,0 +1,80 @@ + + + + + userRole + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Akismet Kotlin/net.thauvin.erik.akismet/CommentConfig/userRole
+
+

userRole

+
+
var userRole: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-akismet -kotlin/net.thauvin.erik.akismet/index.html b/docs/-akismet -kotlin/net.thauvin.erik.akismet/index.html index bbb72b5..f2b4375 100644 --- a/docs/-akismet -kotlin/net.thauvin.erik.akismet/index.html +++ b/docs/-akismet -kotlin/net.thauvin.erik.akismet/index.html @@ -102,13 +102,28 @@ + +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CommentConfig constructor(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<String, String> = emptyMap())

Provides a comment configuration.

+
+
+
+
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/-akismet -kotlin/package-list b/docs/-akismet -kotlin/package-list index e7dce2a..28d612c 100644 --- a/docs/-akismet -kotlin/package-list +++ b/docs/-akismet -kotlin/package-list @@ -39,6 +39,7 @@ $dokka.location:net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/P $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 +$dokka.location:net.thauvin.erik.akismet/AkismetComment/AkismetComment/#net.thauvin.erik.akismet.CommentConfig/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html $dokka.location:net.thauvin.erik.akismet/AkismetComment/author/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html $dokka.location:net.thauvin.erik.akismet/AkismetComment/authorEmail/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html $dokka.location:net.thauvin.erik.akismet/AkismetComment/authorUrl/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html @@ -60,5 +61,62 @@ $dokka.location:net.thauvin.erik.akismet/AkismetComment/type/#/PointingToDeclara $dokka.location:net.thauvin.erik.akismet/AkismetComment/userAgent/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html $dokka.location:net.thauvin.erik.akismet/AkismetComment/userIp/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html $dokka.location:net.thauvin.erik.akismet/AkismetComment/userRole/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder///PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/Builder/#kotlin.String#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/author/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/author/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/authorEmail/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/authorEmail/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/authorUrl/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/authorUrl/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/blogCharset/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/blogCharset/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/blogLang/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/blogLang/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/build/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/content/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/content/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/dateGmt/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/dateGmt/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/isTest/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/isTest/#kotlin.Boolean/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/permalink/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/permalink/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/postModifiedGmt/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/postModifiedGmt/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/recheckReason/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/recheckReason/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/referrer/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/referrer/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html +$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/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 +$dokka.location:net.thauvin.erik.akismet/CommentConfig.Builder/userIp/#kotlin.String/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html +$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/#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 +$dokka.location:net.thauvin.erik.akismet/CommentConfig/authorUrl/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/blogCharset/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/blogLang/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/content/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/dateGmt/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/isTest/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/permalink/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/postModifiedGmt/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/recheckReason/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/referrer/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/serverEnv/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html +$dokka.location:net.thauvin.erik.akismet/CommentConfig/type/#/PointingToDeclaration/-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html +$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 net.thauvin.erik.akismet diff --git a/docs/images/homepage.svg b/docs/images/homepage.svg new file mode 100644 index 0000000..e3c83b1 --- /dev/null +++ b/docs/images/homepage.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/index.html b/docs/index.html index c16d667..4a4f063 100644 --- a/docs/index.html +++ b/docs/index.html @@ -90,7 +90,7 @@
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/navigation.html b/docs/navigation.html index aff718a..08fa7f2 100644 --- a/docs/navigation.html +++ b/docs/navigation.html @@ -14,6 +14,12 @@
Companion
+
+
CommentConfig
+
+
Builder
+
+
diff --git a/docs/scripts/pages.json b/docs/scripts/pages.json index bdcd091..ed1cadd 100644 --- a/docs/scripts/pages.json +++ b/docs/scripts/pages.json @@ -1 +1 @@ -[{"name":"const val ADMIN_ROLE: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.ADMIN_ROLE","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html","searchKeys":["ADMIN_ROLE","const val ADMIN_ROLE: String","net.thauvin.erik.akismet.AkismetComment.Companion.ADMIN_ROLE"]},{"name":"const val TYPE_BLOG_POST: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_BLOG_POST","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html","searchKeys":["TYPE_BLOG_POST","const val TYPE_BLOG_POST: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_BLOG_POST"]},{"name":"const val TYPE_COMMENT: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_COMMENT","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html","searchKeys":["TYPE_COMMENT","const val TYPE_COMMENT: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_COMMENT"]},{"name":"const val TYPE_CONTACT_FORM: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_CONTACT_FORM","location":"-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","searchKeys":["TYPE_CONTACT_FORM","const val TYPE_CONTACT_FORM: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_CONTACT_FORM"]},{"name":"const val TYPE_FORUM_POST: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_FORUM_POST","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html","searchKeys":["TYPE_FORUM_POST","const val TYPE_FORUM_POST: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_FORUM_POST"]},{"name":"const val TYPE_MESSAGE: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_MESSAGE","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html","searchKeys":["TYPE_MESSAGE","const val TYPE_MESSAGE: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_MESSAGE"]},{"name":"const val TYPE_PINGBACK: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_PINGBACK","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html","searchKeys":["TYPE_PINGBACK","const val TYPE_PINGBACK: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_PINGBACK"]},{"name":"const val TYPE_REPLY: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_REPLY","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html","searchKeys":["TYPE_REPLY","const val TYPE_REPLY: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_REPLY"]},{"name":"const val TYPE_SIGNUP: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_SIGNUP","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html","searchKeys":["TYPE_SIGNUP","const val TYPE_SIGNUP: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_SIGNUP"]},{"name":"const val TYPE_TRACKBACK: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TRACKBACK","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html","searchKeys":["TYPE_TRACKBACK","const val TYPE_TRACKBACK: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TRACKBACK"]},{"name":"const val TYPE_TWEET: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TWEET","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html","searchKeys":["TYPE_TWEET","const val TYPE_TWEET: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TWEET"]},{"name":"constructor(apiKey: String)","description":"net.thauvin.erik.akismet.Akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html","searchKeys":["Akismet","constructor(apiKey: String)","net.thauvin.erik.akismet.Akismet.Akismet"]},{"name":"constructor(apiKey: String, blog: String)","description":"net.thauvin.erik.akismet.Akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html","searchKeys":["Akismet","constructor(apiKey: String, blog: String)","net.thauvin.erik.akismet.Akismet.Akismet"]},{"name":"constructor(request: )","description":"net.thauvin.erik.akismet.AkismetComment.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html","searchKeys":["AkismetComment","constructor(request: )","net.thauvin.erik.akismet.AkismetComment.AkismetComment"]},{"name":"constructor(userIp: String, userAgent: String)","description":"net.thauvin.erik.akismet.AkismetComment.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html","searchKeys":["AkismetComment","constructor(userIp: String, userAgent: String)","net.thauvin.erik.akismet.AkismetComment.AkismetComment"]},{"name":"fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean","description":"net.thauvin.erik.akismet.Akismet.checkComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html","searchKeys":["checkComment","fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean","net.thauvin.erik.akismet.Akismet.checkComment"]},{"name":"fun dateToGmt(date: Date): String","description":"net.thauvin.erik.akismet.Akismet.Companion.dateToGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html","searchKeys":["dateToGmt","fun dateToGmt(date: Date): String","net.thauvin.erik.akismet.Akismet.Companion.dateToGmt"]},{"name":"fun dateToGmt(date: LocalDateTime): String","description":"net.thauvin.erik.akismet.Akismet.Companion.dateToGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html","searchKeys":["dateToGmt","fun dateToGmt(date: LocalDateTime): String","net.thauvin.erik.akismet.Akismet.Companion.dateToGmt"]},{"name":"fun executeMethod(apiUrl: , formBody: , trueOnError: Boolean = false): Boolean","description":"net.thauvin.erik.akismet.Akismet.executeMethod","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html","searchKeys":["executeMethod","fun executeMethod(apiUrl: , formBody: , trueOnError: Boolean = false): Boolean","net.thauvin.erik.akismet.Akismet.executeMethod"]},{"name":"fun jsonComment(json: String): AkismetComment","description":"net.thauvin.erik.akismet.Akismet.Companion.jsonComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html","searchKeys":["jsonComment","fun jsonComment(json: String): AkismetComment","net.thauvin.erik.akismet.Akismet.Companion.jsonComment"]},{"name":"fun reset()","description":"net.thauvin.erik.akismet.Akismet.reset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html","searchKeys":["reset","fun reset()","net.thauvin.erik.akismet.Akismet.reset"]},{"name":"fun submitHam(comment: AkismetComment): Boolean","description":"net.thauvin.erik.akismet.Akismet.submitHam","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html","searchKeys":["submitHam","fun submitHam(comment: AkismetComment): Boolean","net.thauvin.erik.akismet.Akismet.submitHam"]},{"name":"fun submitSpam(comment: AkismetComment): Boolean","description":"net.thauvin.erik.akismet.Akismet.submitSpam","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html","searchKeys":["submitSpam","fun submitSpam(comment: AkismetComment): Boolean","net.thauvin.erik.akismet.Akismet.submitSpam"]},{"name":"fun toJson(): String","description":"net.thauvin.erik.akismet.AkismetComment.toJson","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html","searchKeys":["toJson","fun toJson(): String","net.thauvin.erik.akismet.AkismetComment.toJson"]},{"name":"fun verifyKey(): Boolean","description":"net.thauvin.erik.akismet.Akismet.verifyKey","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html","searchKeys":["verifyKey","fun verifyKey(): Boolean","net.thauvin.erik.akismet.Akismet.verifyKey"]},{"name":"object Companion","description":"net.thauvin.erik.akismet.Akismet.Companion","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html","searchKeys":["Companion","object Companion","net.thauvin.erik.akismet.Akismet.Companion"]},{"name":"object Companion","description":"net.thauvin.erik.akismet.AkismetComment.Companion","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html","searchKeys":["Companion","object Companion","net.thauvin.erik.akismet.AkismetComment.Companion"]},{"name":"open class Akismet(apiKey: String)","description":"net.thauvin.erik.akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html","searchKeys":["Akismet","open class Akismet(apiKey: String)","net.thauvin.erik.akismet.Akismet"]},{"name":"open class AkismetComment(val userIp: String, val userAgent: String)","description":"net.thauvin.erik.akismet.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html","searchKeys":["AkismetComment","open class AkismetComment(val userIp: String, val userAgent: String)","net.thauvin.erik.akismet.AkismetComment"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"net.thauvin.erik.akismet.AkismetComment.equals","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","net.thauvin.erik.akismet.AkismetComment.equals"]},{"name":"open override fun hashCode(): Int","description":"net.thauvin.erik.akismet.AkismetComment.hashCode","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","net.thauvin.erik.akismet.AkismetComment.hashCode"]},{"name":"open override fun toString(): String","description":"net.thauvin.erik.akismet.AkismetComment.toString","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html","searchKeys":["toString","open override fun toString(): String","net.thauvin.erik.akismet.AkismetComment.toString"]},{"name":"val logger: Logger","description":"net.thauvin.erik.akismet.Akismet.logger","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html","searchKeys":["logger","val logger: Logger","net.thauvin.erik.akismet.Akismet.logger"]},{"name":"val userAgent: String","description":"net.thauvin.erik.akismet.AkismetComment.userAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html","searchKeys":["userAgent","val userAgent: String","net.thauvin.erik.akismet.AkismetComment.userAgent"]},{"name":"val userIp: String","description":"net.thauvin.erik.akismet.AkismetComment.userIp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html","searchKeys":["userIp","val userIp: String","net.thauvin.erik.akismet.AkismetComment.userIp"]},{"name":"var appUserAgent: String","description":"net.thauvin.erik.akismet.Akismet.appUserAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html","searchKeys":["appUserAgent","var appUserAgent: String","net.thauvin.erik.akismet.Akismet.appUserAgent"]},{"name":"var author: String?","description":"net.thauvin.erik.akismet.AkismetComment.author","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html","searchKeys":["author","var author: String?","net.thauvin.erik.akismet.AkismetComment.author"]},{"name":"var authorEmail: String?","description":"net.thauvin.erik.akismet.AkismetComment.authorEmail","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html","searchKeys":["authorEmail","var authorEmail: String?","net.thauvin.erik.akismet.AkismetComment.authorEmail"]},{"name":"var authorUrl: String?","description":"net.thauvin.erik.akismet.AkismetComment.authorUrl","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html","searchKeys":["authorUrl","var authorUrl: String?","net.thauvin.erik.akismet.AkismetComment.authorUrl"]},{"name":"var blog: String","description":"net.thauvin.erik.akismet.Akismet.blog","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html","searchKeys":["blog","var blog: String","net.thauvin.erik.akismet.Akismet.blog"]},{"name":"var blogCharset: String?","description":"net.thauvin.erik.akismet.AkismetComment.blogCharset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html","searchKeys":["blogCharset","var blogCharset: String?","net.thauvin.erik.akismet.AkismetComment.blogCharset"]},{"name":"var blogLang: String?","description":"net.thauvin.erik.akismet.AkismetComment.blogLang","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html","searchKeys":["blogLang","var blogLang: String?","net.thauvin.erik.akismet.AkismetComment.blogLang"]},{"name":"var content: String?","description":"net.thauvin.erik.akismet.AkismetComment.content","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html","searchKeys":["content","var content: String?","net.thauvin.erik.akismet.AkismetComment.content"]},{"name":"var dateGmt: String?","description":"net.thauvin.erik.akismet.AkismetComment.dateGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html","searchKeys":["dateGmt","var dateGmt: String?","net.thauvin.erik.akismet.AkismetComment.dateGmt"]},{"name":"var debugHelp: String","description":"net.thauvin.erik.akismet.Akismet.debugHelp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html","searchKeys":["debugHelp","var debugHelp: String","net.thauvin.erik.akismet.Akismet.debugHelp"]},{"name":"var errorMessage: String","description":"net.thauvin.erik.akismet.Akismet.errorMessage","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html","searchKeys":["errorMessage","var errorMessage: String","net.thauvin.erik.akismet.Akismet.errorMessage"]},{"name":"var httpStatusCode: Int","description":"net.thauvin.erik.akismet.Akismet.httpStatusCode","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html","searchKeys":["httpStatusCode","var httpStatusCode: Int","net.thauvin.erik.akismet.Akismet.httpStatusCode"]},{"name":"var isDiscard: Boolean","description":"net.thauvin.erik.akismet.Akismet.isDiscard","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html","searchKeys":["isDiscard","var isDiscard: Boolean","net.thauvin.erik.akismet.Akismet.isDiscard"]},{"name":"var isTest: Boolean","description":"net.thauvin.erik.akismet.AkismetComment.isTest","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html","searchKeys":["isTest","var isTest: Boolean","net.thauvin.erik.akismet.AkismetComment.isTest"]},{"name":"var isVerifiedKey: Boolean","description":"net.thauvin.erik.akismet.Akismet.isVerifiedKey","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html","searchKeys":["isVerifiedKey","var isVerifiedKey: Boolean","net.thauvin.erik.akismet.Akismet.isVerifiedKey"]},{"name":"var permalink: String?","description":"net.thauvin.erik.akismet.AkismetComment.permalink","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html","searchKeys":["permalink","var permalink: String?","net.thauvin.erik.akismet.AkismetComment.permalink"]},{"name":"var postModifiedGmt: String?","description":"net.thauvin.erik.akismet.AkismetComment.postModifiedGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html","searchKeys":["postModifiedGmt","var postModifiedGmt: String?","net.thauvin.erik.akismet.AkismetComment.postModifiedGmt"]},{"name":"var proTip: String","description":"net.thauvin.erik.akismet.Akismet.proTip","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html","searchKeys":["proTip","var proTip: String","net.thauvin.erik.akismet.Akismet.proTip"]},{"name":"var recheckReason: String?","description":"net.thauvin.erik.akismet.AkismetComment.recheckReason","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html","searchKeys":["recheckReason","var recheckReason: String?","net.thauvin.erik.akismet.AkismetComment.recheckReason"]},{"name":"var referrer: String?","description":"net.thauvin.erik.akismet.AkismetComment.referrer","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html","searchKeys":["referrer","var referrer: String?","net.thauvin.erik.akismet.AkismetComment.referrer"]},{"name":"var response: String","description":"net.thauvin.erik.akismet.Akismet.response","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html","searchKeys":["response","var response: String","net.thauvin.erik.akismet.Akismet.response"]},{"name":"var serverEnv: Map","description":"net.thauvin.erik.akismet.AkismetComment.serverEnv","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html","searchKeys":["serverEnv","var serverEnv: Map","net.thauvin.erik.akismet.AkismetComment.serverEnv"]},{"name":"var type: String?","description":"net.thauvin.erik.akismet.AkismetComment.type","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html","searchKeys":["type","var type: String?","net.thauvin.erik.akismet.AkismetComment.type"]},{"name":"var userRole: String?","description":"net.thauvin.erik.akismet.AkismetComment.userRole","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html","searchKeys":["userRole","var userRole: String?","net.thauvin.erik.akismet.AkismetComment.userRole"]}] +[{"name":"class CommentConfig constructor(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 = emptyMap())","description":"net.thauvin.erik.akismet.CommentConfig","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/index.html","searchKeys":["CommentConfig","class CommentConfig constructor(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 = emptyMap())","net.thauvin.erik.akismet.CommentConfig"]},{"name":"const val ADMIN_ROLE: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.ADMIN_ROLE","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-a-d-m-i-n_-r-o-l-e.html","searchKeys":["ADMIN_ROLE","const val ADMIN_ROLE: String","net.thauvin.erik.akismet.AkismetComment.Companion.ADMIN_ROLE"]},{"name":"const val TYPE_BLOG_POST: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_BLOG_POST","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html","searchKeys":["TYPE_BLOG_POST","const val TYPE_BLOG_POST: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_BLOG_POST"]},{"name":"const val TYPE_COMMENT: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_COMMENT","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-c-o-m-m-e-n-t.html","searchKeys":["TYPE_COMMENT","const val TYPE_COMMENT: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_COMMENT"]},{"name":"const val TYPE_CONTACT_FORM: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_CONTACT_FORM","location":"-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","searchKeys":["TYPE_CONTACT_FORM","const val TYPE_CONTACT_FORM: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_CONTACT_FORM"]},{"name":"const val TYPE_FORUM_POST: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_FORUM_POST","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html","searchKeys":["TYPE_FORUM_POST","const val TYPE_FORUM_POST: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_FORUM_POST"]},{"name":"const val TYPE_MESSAGE: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_MESSAGE","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-m-e-s-s-a-g-e.html","searchKeys":["TYPE_MESSAGE","const val TYPE_MESSAGE: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_MESSAGE"]},{"name":"const val TYPE_PINGBACK: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_PINGBACK","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html","searchKeys":["TYPE_PINGBACK","const val TYPE_PINGBACK: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_PINGBACK"]},{"name":"const val TYPE_REPLY: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_REPLY","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-r-e-p-l-y.html","searchKeys":["TYPE_REPLY","const val TYPE_REPLY: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_REPLY"]},{"name":"const val TYPE_SIGNUP: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_SIGNUP","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-s-i-g-n-u-p.html","searchKeys":["TYPE_SIGNUP","const val TYPE_SIGNUP: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_SIGNUP"]},{"name":"const val TYPE_TRACKBACK: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TRACKBACK","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html","searchKeys":["TYPE_TRACKBACK","const val TYPE_TRACKBACK: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TRACKBACK"]},{"name":"const val TYPE_TWEET: String","description":"net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TWEET","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/-t-y-p-e_-t-w-e-e-t.html","searchKeys":["TYPE_TWEET","const val TYPE_TWEET: String","net.thauvin.erik.akismet.AkismetComment.Companion.TYPE_TWEET"]},{"name":"constructor(apiKey: String)","description":"net.thauvin.erik.akismet.Akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html","searchKeys":["Akismet","constructor(apiKey: String)","net.thauvin.erik.akismet.Akismet.Akismet"]},{"name":"constructor(apiKey: String, blog: String)","description":"net.thauvin.erik.akismet.Akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-akismet.html","searchKeys":["Akismet","constructor(apiKey: String, blog: String)","net.thauvin.erik.akismet.Akismet.Akismet"]},{"name":"constructor(builder: CommentConfig.Builder)","description":"net.thauvin.erik.akismet.CommentConfig.CommentConfig","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html","searchKeys":["CommentConfig","constructor(builder: CommentConfig.Builder)","net.thauvin.erik.akismet.CommentConfig.CommentConfig"]},{"name":"constructor(config: CommentConfig)","description":"net.thauvin.erik.akismet.AkismetComment.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html","searchKeys":["AkismetComment","constructor(config: CommentConfig)","net.thauvin.erik.akismet.AkismetComment.AkismetComment"]},{"name":"constructor(request: )","description":"net.thauvin.erik.akismet.AkismetComment.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html","searchKeys":["AkismetComment","constructor(request: )","net.thauvin.erik.akismet.AkismetComment.AkismetComment"]},{"name":"constructor(userIp: String, userAgent: String)","description":"net.thauvin.erik.akismet.AkismetComment.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-akismet-comment.html","searchKeys":["AkismetComment","constructor(userIp: String, userAgent: String)","net.thauvin.erik.akismet.AkismetComment.AkismetComment"]},{"name":"constructor(userIp: String, userAgent: String)","description":"net.thauvin.erik.akismet.CommentConfig.Builder.Builder","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/-builder.html","searchKeys":["Builder","constructor(userIp: String, userAgent: String)","net.thauvin.erik.akismet.CommentConfig.Builder.Builder"]},{"name":"constructor(userIp: String, userAgent: String, referrer: String = \"\", permalink: String = \"\", type: String = \"\", author: String = \"\", authorEmail: String = \"\", authorUrl: String = \"\", content: String = \"\", dateGmt: String = \"\", postModifiedGmt: String = \"\", blogLang: String = \"\", blogCharset: String = \"\", userRole: String = \"\", isTest: Boolean = false, recheckReason: String = \"\", serverEnv: Map = emptyMap())","description":"net.thauvin.erik.akismet.CommentConfig.CommentConfig","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-comment-config.html","searchKeys":["CommentConfig","constructor(userIp: String, userAgent: String, referrer: String = \"\", permalink: String = \"\", type: String = \"\", author: String = \"\", authorEmail: String = \"\", authorUrl: String = \"\", content: String = \"\", dateGmt: String = \"\", postModifiedGmt: String = \"\", blogLang: String = \"\", blogCharset: String = \"\", userRole: String = \"\", isTest: Boolean = false, recheckReason: String = \"\", serverEnv: Map = emptyMap())","net.thauvin.erik.akismet.CommentConfig.CommentConfig"]},{"name":"data class Builder(var userIp: String, var userAgent: String)","description":"net.thauvin.erik.akismet.CommentConfig.Builder","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/index.html","searchKeys":["Builder","data class Builder(var userIp: String, var userAgent: String)","net.thauvin.erik.akismet.CommentConfig.Builder"]},{"name":"fun author(author: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.author","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html","searchKeys":["author","fun author(author: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.author"]},{"name":"fun authorEmail(authorEmail: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.authorEmail","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html","searchKeys":["authorEmail","fun authorEmail(authorEmail: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.authorEmail"]},{"name":"fun authorUrl(authorUrl: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.authorUrl","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html","searchKeys":["authorUrl","fun authorUrl(authorUrl: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.authorUrl"]},{"name":"fun blogCharset(blogCharset: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.blogCharset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html","searchKeys":["blogCharset","fun blogCharset(blogCharset: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.blogCharset"]},{"name":"fun blogLang(blogLang: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.blogLang","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html","searchKeys":["blogLang","fun blogLang(blogLang: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.blogLang"]},{"name":"fun build(): CommentConfig","description":"net.thauvin.erik.akismet.CommentConfig.Builder.build","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/build.html","searchKeys":["build","fun build(): CommentConfig","net.thauvin.erik.akismet.CommentConfig.Builder.build"]},{"name":"fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean","description":"net.thauvin.erik.akismet.Akismet.checkComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/check-comment.html","searchKeys":["checkComment","fun checkComment(comment: AkismetComment, trueOnError: Boolean = false): Boolean","net.thauvin.erik.akismet.Akismet.checkComment"]},{"name":"fun content(content: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.content","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html","searchKeys":["content","fun content(content: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.content"]},{"name":"fun dateGmt(dateGmt: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.dateGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html","searchKeys":["dateGmt","fun dateGmt(dateGmt: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.dateGmt"]},{"name":"fun dateToGmt(date: Date): String","description":"net.thauvin.erik.akismet.Akismet.Companion.dateToGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html","searchKeys":["dateToGmt","fun dateToGmt(date: Date): String","net.thauvin.erik.akismet.Akismet.Companion.dateToGmt"]},{"name":"fun dateToGmt(date: LocalDateTime): String","description":"net.thauvin.erik.akismet.Akismet.Companion.dateToGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/date-to-gmt.html","searchKeys":["dateToGmt","fun dateToGmt(date: LocalDateTime): String","net.thauvin.erik.akismet.Akismet.Companion.dateToGmt"]},{"name":"fun executeMethod(apiUrl: , formBody: , trueOnError: Boolean = false): Boolean","description":"net.thauvin.erik.akismet.Akismet.executeMethod","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/execute-method.html","searchKeys":["executeMethod","fun executeMethod(apiUrl: , formBody: , trueOnError: Boolean = false): Boolean","net.thauvin.erik.akismet.Akismet.executeMethod"]},{"name":"fun isTest(isTest: Boolean): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.isTest","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html","searchKeys":["isTest","fun isTest(isTest: Boolean): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.isTest"]},{"name":"fun jsonComment(json: String): AkismetComment","description":"net.thauvin.erik.akismet.Akismet.Companion.jsonComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/json-comment.html","searchKeys":["jsonComment","fun jsonComment(json: String): AkismetComment","net.thauvin.erik.akismet.Akismet.Companion.jsonComment"]},{"name":"fun permalink(permalink: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.permalink","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html","searchKeys":["permalink","fun permalink(permalink: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.permalink"]},{"name":"fun postModifiedGmt(postModifiedGmt: String): ","description":"net.thauvin.erik.akismet.CommentConfig.Builder.postModifiedGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html","searchKeys":["postModifiedGmt","fun postModifiedGmt(postModifiedGmt: String): ","net.thauvin.erik.akismet.CommentConfig.Builder.postModifiedGmt"]},{"name":"fun recheckReason(checkReason: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.recheckReason","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html","searchKeys":["recheckReason","fun recheckReason(checkReason: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.recheckReason"]},{"name":"fun referrer(referrer: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.referrer","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html","searchKeys":["referrer","fun referrer(referrer: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.referrer"]},{"name":"fun reset()","description":"net.thauvin.erik.akismet.Akismet.reset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/reset.html","searchKeys":["reset","fun reset()","net.thauvin.erik.akismet.Akismet.reset"]},{"name":"fun serverEnv(serverEnv: Map): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.serverEnv","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html","searchKeys":["serverEnv","fun serverEnv(serverEnv: Map): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.serverEnv"]},{"name":"fun submitHam(comment: AkismetComment): Boolean","description":"net.thauvin.erik.akismet.Akismet.submitHam","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-ham.html","searchKeys":["submitHam","fun submitHam(comment: AkismetComment): Boolean","net.thauvin.erik.akismet.Akismet.submitHam"]},{"name":"fun submitSpam(comment: AkismetComment): Boolean","description":"net.thauvin.erik.akismet.Akismet.submitSpam","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/submit-spam.html","searchKeys":["submitSpam","fun submitSpam(comment: AkismetComment): Boolean","net.thauvin.erik.akismet.Akismet.submitSpam"]},{"name":"fun toJson(): String","description":"net.thauvin.erik.akismet.AkismetComment.toJson","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-json.html","searchKeys":["toJson","fun toJson(): String","net.thauvin.erik.akismet.AkismetComment.toJson"]},{"name":"fun type(type: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.type","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html","searchKeys":["type","fun type(type: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.type"]},{"name":"fun userAgent(userAgent: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html","searchKeys":["userAgent","fun userAgent(userAgent: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.userAgent"]},{"name":"fun userIp(userIp: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userIp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html","searchKeys":["userIp","fun userIp(userIp: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.userIp"]},{"name":"fun userRole(userRole: String): CommentConfig.Builder","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userRole","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html","searchKeys":["userRole","fun userRole(userRole: String): CommentConfig.Builder","net.thauvin.erik.akismet.CommentConfig.Builder.userRole"]},{"name":"fun verifyKey(): Boolean","description":"net.thauvin.erik.akismet.Akismet.verifyKey","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/verify-key.html","searchKeys":["verifyKey","fun verifyKey(): Boolean","net.thauvin.erik.akismet.Akismet.verifyKey"]},{"name":"object Companion","description":"net.thauvin.erik.akismet.Akismet.Companion","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/-companion/index.html","searchKeys":["Companion","object Companion","net.thauvin.erik.akismet.Akismet.Companion"]},{"name":"object Companion","description":"net.thauvin.erik.akismet.AkismetComment.Companion","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/-companion/index.html","searchKeys":["Companion","object Companion","net.thauvin.erik.akismet.AkismetComment.Companion"]},{"name":"open class Akismet(apiKey: String)","description":"net.thauvin.erik.akismet.Akismet","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/index.html","searchKeys":["Akismet","open class Akismet(apiKey: String)","net.thauvin.erik.akismet.Akismet"]},{"name":"open class AkismetComment(val userIp: String, val userAgent: String)","description":"net.thauvin.erik.akismet.AkismetComment","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/index.html","searchKeys":["AkismetComment","open class AkismetComment(val userIp: String, val userAgent: String)","net.thauvin.erik.akismet.AkismetComment"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"net.thauvin.erik.akismet.AkismetComment.equals","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","net.thauvin.erik.akismet.AkismetComment.equals"]},{"name":"open override fun hashCode(): Int","description":"net.thauvin.erik.akismet.AkismetComment.hashCode","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","net.thauvin.erik.akismet.AkismetComment.hashCode"]},{"name":"open override fun toString(): String","description":"net.thauvin.erik.akismet.AkismetComment.toString","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/to-string.html","searchKeys":["toString","open override fun toString(): String","net.thauvin.erik.akismet.AkismetComment.toString"]},{"name":"val logger: Logger","description":"net.thauvin.erik.akismet.Akismet.logger","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/logger.html","searchKeys":["logger","val logger: Logger","net.thauvin.erik.akismet.Akismet.logger"]},{"name":"val userAgent: String","description":"net.thauvin.erik.akismet.AkismetComment.userAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-agent.html","searchKeys":["userAgent","val userAgent: String","net.thauvin.erik.akismet.AkismetComment.userAgent"]},{"name":"val userIp: String","description":"net.thauvin.erik.akismet.AkismetComment.userIp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-ip.html","searchKeys":["userIp","val userIp: String","net.thauvin.erik.akismet.AkismetComment.userIp"]},{"name":"var appUserAgent: String","description":"net.thauvin.erik.akismet.Akismet.appUserAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/app-user-agent.html","searchKeys":["appUserAgent","var appUserAgent: String","net.thauvin.erik.akismet.Akismet.appUserAgent"]},{"name":"var author: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.author","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author.html","searchKeys":["author","var author: String","net.thauvin.erik.akismet.CommentConfig.Builder.author"]},{"name":"var author: String","description":"net.thauvin.erik.akismet.CommentConfig.author","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author.html","searchKeys":["author","var author: String","net.thauvin.erik.akismet.CommentConfig.author"]},{"name":"var author: String?","description":"net.thauvin.erik.akismet.AkismetComment.author","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author.html","searchKeys":["author","var author: String?","net.thauvin.erik.akismet.AkismetComment.author"]},{"name":"var authorEmail: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.authorEmail","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-email.html","searchKeys":["authorEmail","var authorEmail: String","net.thauvin.erik.akismet.CommentConfig.Builder.authorEmail"]},{"name":"var authorEmail: String","description":"net.thauvin.erik.akismet.CommentConfig.authorEmail","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-email.html","searchKeys":["authorEmail","var authorEmail: String","net.thauvin.erik.akismet.CommentConfig.authorEmail"]},{"name":"var authorEmail: String?","description":"net.thauvin.erik.akismet.AkismetComment.authorEmail","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-email.html","searchKeys":["authorEmail","var authorEmail: String?","net.thauvin.erik.akismet.AkismetComment.authorEmail"]},{"name":"var authorUrl: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.authorUrl","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/author-url.html","searchKeys":["authorUrl","var authorUrl: String","net.thauvin.erik.akismet.CommentConfig.Builder.authorUrl"]},{"name":"var authorUrl: String","description":"net.thauvin.erik.akismet.CommentConfig.authorUrl","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/author-url.html","searchKeys":["authorUrl","var authorUrl: String","net.thauvin.erik.akismet.CommentConfig.authorUrl"]},{"name":"var authorUrl: String?","description":"net.thauvin.erik.akismet.AkismetComment.authorUrl","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/author-url.html","searchKeys":["authorUrl","var authorUrl: String?","net.thauvin.erik.akismet.AkismetComment.authorUrl"]},{"name":"var blog: String","description":"net.thauvin.erik.akismet.Akismet.blog","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/blog.html","searchKeys":["blog","var blog: String","net.thauvin.erik.akismet.Akismet.blog"]},{"name":"var blogCharset: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.blogCharset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-charset.html","searchKeys":["blogCharset","var blogCharset: String","net.thauvin.erik.akismet.CommentConfig.Builder.blogCharset"]},{"name":"var blogCharset: String","description":"net.thauvin.erik.akismet.CommentConfig.blogCharset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-charset.html","searchKeys":["blogCharset","var blogCharset: String","net.thauvin.erik.akismet.CommentConfig.blogCharset"]},{"name":"var blogCharset: String?","description":"net.thauvin.erik.akismet.AkismetComment.blogCharset","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-charset.html","searchKeys":["blogCharset","var blogCharset: String?","net.thauvin.erik.akismet.AkismetComment.blogCharset"]},{"name":"var blogLang: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.blogLang","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/blog-lang.html","searchKeys":["blogLang","var blogLang: String","net.thauvin.erik.akismet.CommentConfig.Builder.blogLang"]},{"name":"var blogLang: String","description":"net.thauvin.erik.akismet.CommentConfig.blogLang","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/blog-lang.html","searchKeys":["blogLang","var blogLang: String","net.thauvin.erik.akismet.CommentConfig.blogLang"]},{"name":"var blogLang: String?","description":"net.thauvin.erik.akismet.AkismetComment.blogLang","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/blog-lang.html","searchKeys":["blogLang","var blogLang: String?","net.thauvin.erik.akismet.AkismetComment.blogLang"]},{"name":"var content: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.content","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/content.html","searchKeys":["content","var content: String","net.thauvin.erik.akismet.CommentConfig.Builder.content"]},{"name":"var content: String","description":"net.thauvin.erik.akismet.CommentConfig.content","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/content.html","searchKeys":["content","var content: String","net.thauvin.erik.akismet.CommentConfig.content"]},{"name":"var content: String?","description":"net.thauvin.erik.akismet.AkismetComment.content","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/content.html","searchKeys":["content","var content: String?","net.thauvin.erik.akismet.AkismetComment.content"]},{"name":"var dateGmt: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.dateGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/date-gmt.html","searchKeys":["dateGmt","var dateGmt: String","net.thauvin.erik.akismet.CommentConfig.Builder.dateGmt"]},{"name":"var dateGmt: String","description":"net.thauvin.erik.akismet.CommentConfig.dateGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/date-gmt.html","searchKeys":["dateGmt","var dateGmt: String","net.thauvin.erik.akismet.CommentConfig.dateGmt"]},{"name":"var dateGmt: String?","description":"net.thauvin.erik.akismet.AkismetComment.dateGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/date-gmt.html","searchKeys":["dateGmt","var dateGmt: String?","net.thauvin.erik.akismet.AkismetComment.dateGmt"]},{"name":"var debugHelp: String","description":"net.thauvin.erik.akismet.Akismet.debugHelp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/debug-help.html","searchKeys":["debugHelp","var debugHelp: String","net.thauvin.erik.akismet.Akismet.debugHelp"]},{"name":"var errorMessage: String","description":"net.thauvin.erik.akismet.Akismet.errorMessage","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/error-message.html","searchKeys":["errorMessage","var errorMessage: String","net.thauvin.erik.akismet.Akismet.errorMessage"]},{"name":"var httpStatusCode: Int","description":"net.thauvin.erik.akismet.Akismet.httpStatusCode","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/http-status-code.html","searchKeys":["httpStatusCode","var httpStatusCode: Int","net.thauvin.erik.akismet.Akismet.httpStatusCode"]},{"name":"var isDiscard: Boolean","description":"net.thauvin.erik.akismet.Akismet.isDiscard","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-discard.html","searchKeys":["isDiscard","var isDiscard: Boolean","net.thauvin.erik.akismet.Akismet.isDiscard"]},{"name":"var isTest: Boolean","description":"net.thauvin.erik.akismet.AkismetComment.isTest","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/is-test.html","searchKeys":["isTest","var isTest: Boolean","net.thauvin.erik.akismet.AkismetComment.isTest"]},{"name":"var isTest: Boolean","description":"net.thauvin.erik.akismet.CommentConfig.Builder.isTest","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/is-test.html","searchKeys":["isTest","var isTest: Boolean","net.thauvin.erik.akismet.CommentConfig.Builder.isTest"]},{"name":"var isTest: Boolean","description":"net.thauvin.erik.akismet.CommentConfig.isTest","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/is-test.html","searchKeys":["isTest","var isTest: Boolean","net.thauvin.erik.akismet.CommentConfig.isTest"]},{"name":"var isVerifiedKey: Boolean","description":"net.thauvin.erik.akismet.Akismet.isVerifiedKey","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/is-verified-key.html","searchKeys":["isVerifiedKey","var isVerifiedKey: Boolean","net.thauvin.erik.akismet.Akismet.isVerifiedKey"]},{"name":"var permalink: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.permalink","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/permalink.html","searchKeys":["permalink","var permalink: String","net.thauvin.erik.akismet.CommentConfig.Builder.permalink"]},{"name":"var permalink: String","description":"net.thauvin.erik.akismet.CommentConfig.permalink","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/permalink.html","searchKeys":["permalink","var permalink: String","net.thauvin.erik.akismet.CommentConfig.permalink"]},{"name":"var permalink: String?","description":"net.thauvin.erik.akismet.AkismetComment.permalink","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/permalink.html","searchKeys":["permalink","var permalink: String?","net.thauvin.erik.akismet.AkismetComment.permalink"]},{"name":"var postModifiedGmt: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.postModifiedGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/post-modified-gmt.html","searchKeys":["postModifiedGmt","var postModifiedGmt: String","net.thauvin.erik.akismet.CommentConfig.Builder.postModifiedGmt"]},{"name":"var postModifiedGmt: String","description":"net.thauvin.erik.akismet.CommentConfig.postModifiedGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/post-modified-gmt.html","searchKeys":["postModifiedGmt","var postModifiedGmt: String","net.thauvin.erik.akismet.CommentConfig.postModifiedGmt"]},{"name":"var postModifiedGmt: String?","description":"net.thauvin.erik.akismet.AkismetComment.postModifiedGmt","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/post-modified-gmt.html","searchKeys":["postModifiedGmt","var postModifiedGmt: String?","net.thauvin.erik.akismet.AkismetComment.postModifiedGmt"]},{"name":"var proTip: String","description":"net.thauvin.erik.akismet.Akismet.proTip","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/pro-tip.html","searchKeys":["proTip","var proTip: String","net.thauvin.erik.akismet.Akismet.proTip"]},{"name":"var recheckReason: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.recheckReason","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/recheck-reason.html","searchKeys":["recheckReason","var recheckReason: String","net.thauvin.erik.akismet.CommentConfig.Builder.recheckReason"]},{"name":"var recheckReason: String","description":"net.thauvin.erik.akismet.CommentConfig.recheckReason","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/recheck-reason.html","searchKeys":["recheckReason","var recheckReason: String","net.thauvin.erik.akismet.CommentConfig.recheckReason"]},{"name":"var recheckReason: String?","description":"net.thauvin.erik.akismet.AkismetComment.recheckReason","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/recheck-reason.html","searchKeys":["recheckReason","var recheckReason: String?","net.thauvin.erik.akismet.AkismetComment.recheckReason"]},{"name":"var referrer: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.referrer","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/referrer.html","searchKeys":["referrer","var referrer: String","net.thauvin.erik.akismet.CommentConfig.Builder.referrer"]},{"name":"var referrer: String","description":"net.thauvin.erik.akismet.CommentConfig.referrer","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/referrer.html","searchKeys":["referrer","var referrer: String","net.thauvin.erik.akismet.CommentConfig.referrer"]},{"name":"var referrer: String?","description":"net.thauvin.erik.akismet.AkismetComment.referrer","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/referrer.html","searchKeys":["referrer","var referrer: String?","net.thauvin.erik.akismet.AkismetComment.referrer"]},{"name":"var response: String","description":"net.thauvin.erik.akismet.Akismet.response","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet/response.html","searchKeys":["response","var response: String","net.thauvin.erik.akismet.Akismet.response"]},{"name":"var serverEnv: Map","description":"net.thauvin.erik.akismet.AkismetComment.serverEnv","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/server-env.html","searchKeys":["serverEnv","var serverEnv: Map","net.thauvin.erik.akismet.AkismetComment.serverEnv"]},{"name":"var serverEnv: Map","description":"net.thauvin.erik.akismet.CommentConfig.Builder.serverEnv","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/server-env.html","searchKeys":["serverEnv","var serverEnv: Map","net.thauvin.erik.akismet.CommentConfig.Builder.serverEnv"]},{"name":"var serverEnv: Map","description":"net.thauvin.erik.akismet.CommentConfig.serverEnv","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/server-env.html","searchKeys":["serverEnv","var serverEnv: Map","net.thauvin.erik.akismet.CommentConfig.serverEnv"]},{"name":"var type: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.type","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/type.html","searchKeys":["type","var type: String","net.thauvin.erik.akismet.CommentConfig.Builder.type"]},{"name":"var type: String","description":"net.thauvin.erik.akismet.CommentConfig.type","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/type.html","searchKeys":["type","var type: String","net.thauvin.erik.akismet.CommentConfig.type"]},{"name":"var type: String?","description":"net.thauvin.erik.akismet.AkismetComment.type","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/type.html","searchKeys":["type","var type: String?","net.thauvin.erik.akismet.AkismetComment.type"]},{"name":"var userAgent: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-agent.html","searchKeys":["userAgent","var userAgent: String","net.thauvin.erik.akismet.CommentConfig.Builder.userAgent"]},{"name":"var userAgent: String","description":"net.thauvin.erik.akismet.CommentConfig.userAgent","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-agent.html","searchKeys":["userAgent","var userAgent: String","net.thauvin.erik.akismet.CommentConfig.userAgent"]},{"name":"var userIp: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userIp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-ip.html","searchKeys":["userIp","var userIp: String","net.thauvin.erik.akismet.CommentConfig.Builder.userIp"]},{"name":"var userIp: String","description":"net.thauvin.erik.akismet.CommentConfig.userIp","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-ip.html","searchKeys":["userIp","var userIp: String","net.thauvin.erik.akismet.CommentConfig.userIp"]},{"name":"var userRole: String","description":"net.thauvin.erik.akismet.CommentConfig.Builder.userRole","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/-builder/user-role.html","searchKeys":["userRole","var userRole: String","net.thauvin.erik.akismet.CommentConfig.Builder.userRole"]},{"name":"var userRole: String","description":"net.thauvin.erik.akismet.CommentConfig.userRole","location":"-akismet -kotlin/net.thauvin.erik.akismet/-comment-config/user-role.html","searchKeys":["userRole","var userRole: String","net.thauvin.erik.akismet.CommentConfig.userRole"]},{"name":"var userRole: String?","description":"net.thauvin.erik.akismet.AkismetComment.userRole","location":"-akismet -kotlin/net.thauvin.erik.akismet/-akismet-comment/user-role.html","searchKeys":["userRole","var userRole: String?","net.thauvin.erik.akismet.AkismetComment.userRole"]}] diff --git a/docs/scripts/platform-content-handler.js b/docs/scripts/platform-content-handler.js index 8c4ca53..811c478 100644 --- a/docs/scripts/platform-content-handler.js +++ b/docs/scripts/platform-content-handler.js @@ -18,8 +18,6 @@ const samplesLightThemeName = 'idea' window.addEventListener('load', () => { document.querySelectorAll("div[data-platform-hinted]") .forEach(elem => elem.addEventListener('click', (event) => togglePlatformDependent(event, elem))) - document.querySelectorAll("div[tabs-section]") - .forEach(elem => elem.addEventListener('click', (event) => toggleSectionsEventHandler(event))) const filterSection = document.getElementById('filter-section') if (filterSection) { filterSection.addEventListener('click', (event) => filterButtonHandler(event)) @@ -177,19 +175,30 @@ function handleAnchor() { } function initTabs() { - document.querySelectorAll("div[tabs-section]") - .forEach(element => { - showCorrespondingTabBody(element) - element.addEventListener('click', (event) => toggleSectionsEventHandler(event)) - }) - let cached = localStorage.getItem("active-tab") - if (cached) { - let parsed = JSON.parse(cached) - let tab = document.querySelector('div[tabs-section] > button[data-togglable="' + parsed + '"]') - if (tab) { - toggleSections(tab) - } - } + // we could have only a single type of data - classlike or package + const mainContent = document.querySelector('.main-content'); + const type = mainContent ? mainContent.getAttribute("data-page-type") : null; + const localStorageKey = "active-tab-" + type; + document.querySelectorAll('div[tabs-section]').forEach(element => { + showCorrespondingTabBody(element); + element.addEventListener('click', ({target}) => { + const togglable = target ? target.getAttribute("data-togglable") : null; + if (!togglable) return; + + localStorage.setItem(localStorageKey, JSON.stringify(togglable)); + toggleSections(target); + }); + }); + + const cached = localStorage.getItem(localStorageKey); + if (!cached) return; + + const tab = document.querySelector( + 'div[tabs-section] > button[data-togglable="' + JSON.parse(cached) + '"]' + ); + if (!tab) return; + + toggleSections(tab); } function showCorrespondingTabBody(element) { @@ -293,12 +302,6 @@ function toggleSections(target) { activateTabsBody("tabs-section-body") } -function toggleSectionsEventHandler(evt) { - if (!evt.target.getAttribute("data-togglable")) return - localStorage.setItem('active-tab', JSON.stringify(evt.target.getAttribute("data-togglable"))) - toggleSections(evt.target) -} - function togglePlatformDependent(e, container) { let target = e.target if (target.tagName != 'BUTTON') return; diff --git a/docs/styles/main.css b/docs/styles/main.css index ebe1ce1..5f7781e 100644 --- a/docs/styles/main.css +++ b/docs/styles/main.css @@ -1,6 +1,6 @@ /*! * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. - */#pages-search{cursor:pointer;border:none;border-radius:50%;background:transparent;fill:#fff;fill:var(--dark-mode-and-search-icon-color)}#pages-search:focus{outline:none}#pages-search:hover{background:var(--white-10)}.search,.search [data-test=ring-select],.search [data-test=ring-tooltip],.search [data-test=ring-select_focus],.search #pages-search{display:inline-block;padding:0;margin:0;font-size:0;line-height:0}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important} + */#pages-search{cursor:pointer;border:none;border-radius:50%;background:transparent;fill:#fff;fill:var(--dark-mode-and-search-icon-color)}#pages-search:hover{background:var(--white-10)}.search,.search [data-test=ring-select],.search [data-test=ring-tooltip],.search [data-test=ring-select_focus],.search #pages-search{display:inline-block;padding:0;margin:0;font-size:0;line-height:0}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important;color:rgba(255,255,255,.8)}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important} /* stylelint-disable color-no-hex */ :root { diff --git a/docs/styles/style.css b/docs/styles/style.css index 67a899a..fc2b84d 100644 --- a/docs/styles/style.css +++ b/docs/styles/style.css @@ -342,6 +342,7 @@ td:first-child { /* --- Navigation controls --- */ .navigation-controls { display: flex; + margin-left: 4px; } @media (min-width: 760px) { @@ -354,37 +355,31 @@ td:first-child { display: none; } -/* --- Navigation THEME --- */ -.navigation-controls--search { +.navigation-controls--btn { display: inline-flex; - font-size: 0; - line-height: 0; -} - -.navigation-controls--theme { - display: block; + align-items: center; + justify-content: center; + width: 40px; + height: 40px; border-radius: 50%; background-color: inherit; - margin-left: 4px; + background-position: 50% 50%; padding: 0; border: none; cursor: pointer; font-size: 0; line-height: 0; + transition: background-color 200ms ease-in-out; + will-change: background-color; } -.navigation-controls--theme::before { - height: 40px; - width: 40px; +.navigation-controls--btn:hover { + background-color: var(--white-10); } -.navigation-controls--theme:hover { - background: var(--white-10); -} - -.navigation-controls--theme::before { - display: block; - content: url("../images/theme-toggle.svg"); +.navigation-controls--theme { + background-image: url("../images/theme-toggle.svg"); + background-repeat: no-repeat; } @media (max-width: 759px) { @@ -392,7 +387,18 @@ td:first-child { display: none; } } -/* /--- Navigation THEME --- */ + +.navigation-controls--homepage { + background-image: url("../images/homepage.svg"); + background-repeat: no-repeat; + background-size: 24px 24px; +} + +@media (max-width: 759px) { + .navigation-controls--homepage { + display: none; + } +} .navigation .platform-selector:not([data-active]) { color: #fff; @@ -656,6 +662,26 @@ code.paragraph { text-decoration: line-through; } +/* Workaround for Firefox https://github.com/Kotlin/dokka/issues/3156 */ +@-moz-document url-prefix() { + .strikethrough { + position: relative; + text-decoration: none; + } + + /* complex selectors here are required to handle multiline cases */ + .strikethrough::after, .strikethrough span:after { + content: ''; + position: absolute; + top: 7px; + left: 0; + right: 0; + height: 1px; + background-color: currentColor; + z-index: 1; + } +} + .symbol:empty { padding: 0; } @@ -684,7 +710,7 @@ code { code:not(.block) { display: inline-block; - vertical-align: middle; + vertical-align: bottom; } .symbol > a {