Compare commits

...

63 commits

Author SHA1 Message Date
bc9e32b4bb
Combine Kotlin compile options 2025-03-20 20:37:27 -07:00
fed1c6aee2
Add Kotlin compile options for JDK 24 2025-03-20 09:50:06 -07:00
364584e4c3
Add Kotlin compile options for JDK 24 2025-03-20 09:47:22 -07:00
28b8b05cca
Add Kotlin compile options for JDK 24 2025-03-20 09:46:00 -07:00
679fba1441
Bump Kotlin to version 2.1.20 2025-03-20 09:44:19 -07:00
722ec4f6ba
JDK 24 2025-03-18 23:48:24 -07:00
ce065432c8
Add Junit Platform Launcher dependency 2025-03-18 04:21:04 -07:00
ecefec7914
Update Java/Kotlin to latest versions 2025-03-16 17:06:46 -07:00
c056b9c3e7
Update license copyright 2025-03-16 12:55:07 -07:00
c94f7331bd
Fix IDEA project 2025-03-16 12:42:07 -07:00
cb5cd8fc84
Update copyright 2025-03-16 12:16:33 -07:00
c9ed08d95d
Update root pom 2025-03-16 12:14:50 -07:00
72f89a26ee
Remove IDEA app module 2025-03-16 11:28:30 -07:00
9f6c444ba2
Update extensions dependencies
Bump Detekt extension to version 0.9.9
Bump Dokka extension to version 1.0.3
Bump Generated Version extension to version 1.0.0
Bump Jacoco Report extension to version 0.9.9
2025-03-16 11:28:00 -07:00
bcc8955f92
Bump Java matrix from version 22 to 23 2025-03-16 11:26:28 -07:00
921725ede4
Bump Gradle to version 8.13 2025-03-16 11:25:40 -07:00
48d43843d2
Bump Kotlin extension to version 1.0.4 2025-03-16 11:24:50 -07:00
c707eefa4f
Add pomRoot to publishLocal 2025-03-16 11:23:10 -07:00
c770e8a659
Bump Mockito to version 5.16.1 2025-03-16 11:22:36 -07:00
6e1f299100
Bump JUnit to version 5.12.1 2025-03-16 11:21:35 -07:00
29bf8369e1
Bump Kotlin to version 2.1.0 2025-03-16 11:20:57 -07:00
7b0a467316
Bump bld to version 2.2.1 2025-03-16 11:16:08 -07:00
00641bab1a
1.1.0-SNAPSHOT 2024-09-19 18:31:55 -07:00
da280da5ac
Updated dependencies
Bumped Mockito to version 5.13.0
Bumpled JUnit to version 5.11.0
2024-09-19 18:29:21 -07:00
871174e64a
Bump Kotlin to version 2.0.20 2024-09-19 18:19:07 -07:00
fdd10f1399
Bumped bld to version 2.1.0 2024-09-19 18:16:58 -07:00
4fa2b549ad
Updated Kotlin dependencies
Kotlin extension to version 1.0.0-SNAPSHOT
Dokka extension to version 1.0.0-SNAPSHOT
2024-07-15 14:44:18 -07:00
7720a93d0a
Disabled Dokka for testing 2024-07-11 19:55:07 -07:00
c3c4ae20ad
Kotlin 2.0.0 cleanups 2024-07-11 19:54:22 -07:00
086c736b9e
Updated dependencies 2024-07-11 19:52:45 -07:00
f823e5a0fe
Bumped extensions versions
Bumped Kotlin extension to version 0.9.8
Bumped Generated Version extension to version 0.9.6
2024-05-27 18:01:16 -07:00
19956a337f
Made config constructor private 2024-05-26 00:25:49 -07:00
56a8cbd7f7
Fixed docs generation classpath 2024-05-25 01:18:29 -07:00
d3cabe5e83
Bumped version to 1.1.0-SNAPSHOT 2024-05-24 17:42:07 -07:00
8ff15ff59f
Updated README examples 2024-05-24 17:31:52 -07:00
0480a72c30
Added a data class for the comment types 2024-05-24 17:25:57 -07:00
156d85fee1
Updated docs 2024-05-24 02:45:08 -07:00
c5810c1986
Added comment config and builder 2024-05-24 02:41:38 -07:00
539bb6fbc0
Reverted back to Kotlin 1.9.24 as koltinx-serialization-json is not yet compatible with 2.0.0 2024-05-24 01:29:17 -07:00
2c64779c18
Minor cleanup 2024-05-23 22:22:33 -07:00
6eede8886d
Bumped Kotlin to version 2.0.0 2024-05-23 22:20:43 -07:00
4d305c4a81
Added serialization plugin 2024-05-11 22:39:06 -07:00
92b21fce9e
Bumped Mockito to version 5.12.0 2024-05-11 13:04:31 -07:00
ceedb5009d
Updated copyright 2024-05-10 00:46:11 -07:00
b102f99bd1
Bumped JaCoCo extension to version 0.9.5 2024-05-09 23:47:42 -07:00
5b837efc2a
Bumped Kotlin to version 1.9.24 2024-05-09 23:47:42 -07:00
e64983b5c7
Bumped Gradle to version 8.7 2024-05-09 23:47:42 -07:00
485641e67f
Bumped bld to version 1.9.1 2024-05-09 23:47:42 -07:00
764322bbbd
Bumped workflow actions to latest versions 2024-05-09 23:47:37 -07:00
96497b62e7
Bumped Mockito to version 5.11.0 2024-03-21 00:21:24 -07:00
c97e77e5f0 Bumped to bld 1.9.0 2024-02-26 17:28:22 -08:00
f5dafce5b3 Moved bld badge 2024-01-31 19:32:32 -08:00
23fd735a0d Added contributing section 2024-01-31 18:07:01 -08:00
44a2678de9 Using provided directory for Kotlin serialization plugin 2024-01-31 16:41:17 -08:00
d180795974 Bumped dependencies 2024-01-31 16:14:00 -08:00
befda9c35e Bumped bld to 1.8.0 2024-01-31 16:02:46 -08:00
ac5cb0ef07 Added detekt extension 2023-11-25 21:46:55 -08:00
b4194b765a Upgraded to Kotlin 1.9.21 2023-11-23 17:56:29 -08:00
f850dbb51c Minor cleanup 2023-11-13 12:42:58 -08:00
a950274d35 Fixed bld-ci badge 2023-11-12 15:51:14 -08:00
d5e21dd3a1 Moved from Gradle to bld 2023-11-12 15:12:11 -08:00
7ef1c441e6 Updated copyright 2023-09-24 21:11:36 -07:00
20f413b986 Minor cleanup 2023-09-24 20:08:37 -07:00
357 changed files with 18926 additions and 2828 deletions

View file

@ -1,55 +1,62 @@
version: 2
version: 2.1
orbs:
sdkman: joshdholtz/sdkman@0.2.0
defaults: &defaults
working_directory: ~/repo
environment:
JVM_OPTS: -Xmx3200m
TERM: dumb
CI: true
CI_NAME: "CircleCI"
defaults_gradle: &defaults_gradle
commands:
build_and_test:
parameters:
reports-dir:
type: string
default: "build/reports/test_results"
steps:
- checkout
- restore_cache:
keys:
- gradle-dependencies-{{ checksum "build.gradle.kts" }}
# fallback to using the latest cache if no exact match is found
- gradle-dependencies-
- sdkman/setup-sdkman
- sdkman/sdkman-install:
candidate: kotlin
version: 2.1.10
- run:
name: Gradle Dependencies
command: ./gradlew dependencies
- save_cache:
paths: ~/.m2
key: gradle-dependencies-{{ checksum "build.gradle.kts" }}
name: Download dependencies
command: ./bld download
- run:
name: Run All Checks
command: ./gradlew check
- store_artifacts:
path: build/reports/
destination: reports
name: Compile source
command: ./bld compile
- run:
name: Run tests
command: ./bld jacoco -reports-dir=<< parameters.reports-dir >>
- store_test_results:
path: build/reports/
path: << parameters.reports-dir >>
- store_artifacts:
path: build/reports/jacoco/test/html
jobs:
build_gradle_jdk18:
bld_jdk17:
<<: *defaults
docker:
- image: cimg/openjdk:18.0
- image: cimg/openjdk:17.0
<<: *defaults_gradle
steps:
- build_and_test
build_gradle_jdk11:
bld_jdk21:
<<: *defaults
docker:
- image: cimg/openjdk:11.0
- image: cimg/openjdk:21.0
<<: *defaults_gradle
steps:
- build_and_test
workflows:
version: 2
gradle:
bld:
jobs:
- build_gradle_jdk11
- build_gradle_jdk18
- bld_jdk17
- bld_jdk21

51
.github/workflows/bld.yml vendored Normal file
View file

@ -0,0 +1,51 @@
name: bld-ci
on: [push, pull_request, workflow_dispatch]
env:
AKISMET_API_KEY: ${{ secrets.AKISMET_API_KEY }}
AKISMET_BLOG: ${{ secrets.AKISMET_BLOG }}
COVERAGE_JDK: "21"
COVERAGE_KOTLIN: "2.0.0"
KOTLIN_HOME: /usr/share/kotlinc
jobs:
build-bld-project:
runs-on: ubuntu-latest
strategy:
matrix:
java-version: [17, 21, 24]
kotlin-version: [1.9.25, 2.1.20]
steps:
- name: Checkout source repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up JDK ${{ matrix.java-version }} with Kotlin ${{ matrix.kotlin-version }}
uses: actions/setup-java@v4
with:
distribution: "zulu"
java-version: ${{ matrix.java-version }}
- name: Download dependencies
run: ./bld download
- name: Compile source
run: ./bld compile
- name: Run tests
run: ./bld jacoco
- name: Remove pom.xml
if: success() && matrix.java-version == env.COVERAGE_JDK && matrix.kotlin-version == env.COVERAGE_KOTLIN
run: rm -rf pom.xml
- name: SonarCloud Scan
if: success() && matrix.java-version == env.COVERAGE_JDK && matrix.kotlin-version == env.COVERAGE_KOTLIN
uses: sonarsource/sonarcloud-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

View file

@ -1,52 +0,0 @@
name: gradle-ci
on: [ push, pull_request, workflow_dispatch ]
jobs:
build:
runs-on: ubuntu-latest
env:
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m"
SONAR_JDK: "17"
strategy:
matrix:
java-version: [ 11, 17, 20 ]
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up JDK ${{ matrix.java-version }}
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: ${{ matrix.java-version }}
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Cache SonarCloud packages
if: matrix.java-version == env.SONAR_JDK
uses: actions/cache@v3
with:
path: ~/.sonar/cache
key: ${{ runner.os }}-sonar
restore-keys: ${{ runner.os }}-sonar
- name: Test with Gradle
uses: gradle/gradle-build-action@v2
env:
AKISMET_BLOG: ${{ secrets.AKISMET_BLOG }}
AKISMET_API_KEY: ${{ secrets.AKISMET_API_KEY }}
with:
arguments: build check --stacktrace
- name: SonarCloud
if: success() && matrix.java-version == env.SONAR_JDK
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: ./gradlew sonar --info

140
.gitignore vendored
View file

@ -1,84 +1,62 @@
!.vscode/extensions.json
!.vscode/launch.json
!.vscode/settings.json
!.vscode/tasks.json
*.class
*.code-workspace
*.ctxt
*.iws
*.log
*.nar
*.rar
*.sublime-*
*.tar.gz
*.zip
.DS_Store
.classpath
.gradle
.history
.kobalt
.mtj.tmp/
.mvn/timing.properties
.mvn/wrapper/maven-wrapper.jar
.nb-gradle
.project
.scannerwork
.settings
.vscode/*
/**/.idea/$CACHE_FILE$
/**/.idea/$PRODUCT_WORKSPACE_FILE$
/**/.idea/**/caches/build_file_checksums.ser
/**/.idea/**/contentModel.xml
/**/.idea/**/dataSources.ids
/**/.idea/**/dataSources.local.xml
/**/.idea/**/dataSources/
/**/.idea/**/dbnavigator.xml
/**/.idea/**/dictionaries
/**/.idea/**/dynamic.xml
/**/.idea/**/gradle.xml
/**/.idea/**/httpRequests
/**/.idea/**/libraries
/**/.idea/**/mongoSettings.xml
/**/.idea/**/replstate.xml
/**/.idea/**/shelf
/**/.idea/**/shelf/
/**/.idea/**/sonarlint*
/**/.idea/**/sqlDataSources.xml
/**/.idea/**/tasks.xml
/**/.idea/**/uiDesigner.xml
/**/.idea/**/usage.statistics.xml
/**/.idea/**/workspace.xml
/**/.idea_modules/
Thumbs.db
__pycache__
.DS_Store
build
lib/bld/**
!lib/bld/bld-wrapper.jar
!lib/bld/bld-wrapper.properties
lib/compile/
lib/runtime/
lib/provided/
lib/standalone/
lib/test/
# IDEA ignores
# User-specific
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
# AWS User-specific
.idea/**/aws.xml
# Generated files
.idea/**/contentModel.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
# Gradle
.idea/**/gradle.xml
# Mongo Explorer plugin
.idea/**/mongoSettings.xml
# mpeltonen/sbt-idea plugin
.idea_modules/
# JIRA plugin
atlassian-ide-plugin.xml
bin/
build/
cmake-build-*/
com_crashlytics_export_strings.xml
crashlytics-build.properties
crashlytics.properties
dependency-reduced-pom.xml
deploy/
dist/
ehthumbs.db
fabric.properties
gen/
hs_err_pid*
kobaltBuild
kobaltw*-test
lib/kotlin*
libs/
# Cursive Clojure plugin
.idea/replstate.xml
# SonarLint plugin
.idea/sonarlint/
# Editor-based Rest Client
.idea/httpRequests
bin
deploy
target
local.properties
out/
pom.xml.asc
pom.xml.next
pom.xml.releaseBackup
pom.xml.tag
pom.xml.versionsBackup
proguard-project.txt
project.properties
release.properties
target/
test-output
venv

View file

@ -1,31 +1,24 @@
image: gradle:8-jdk11
image: fedora:latest
variables:
GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m"
before_script:
- export GRADLE_USER_HOME=`pwd`/.gradle
CI_NAME: "GitLab CI"
stages:
- build
- test
build:
stage: build
script: gradle --build-cache assemble
cache:
key: "$CI_COMMIT_REF_NAME"
policy: push
paths:
- build
- .gradle
before_script:
- dnf -qy update && dnf -y install zip
- curl -s "https://get.sdkman.io" | bash
- echo sdkman_auto_answer=true > $HOME/.sdkman/etc/config
- echo sdkman_auto_selfupdate=true >> $HOME/.sdkman/etc/config
- source "$HOME/.sdkman/bin/sdkman-init.sh"
- sdk install java
- sdk install kotlin
- source "$HOME/.sdkman/bin/sdkman-init.sh"
test:
stage: test
script: gradle check
cache:
key: "$CI_COMMIT_REF_NAME"
policy: pull
paths:
- build
- .gradle
script:
- ./bld download
- ./bld compile
- ./bld test

26
.idea/app.iml generated Normal file
View file

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="JAVA_MODULE" version="4">
<component name="NewModuleRootManager">
<output url="file://$MODULE_DIR$/build/main" />
<output-test url="file://$MODULE_DIR$/build/test" />
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/src/main/kotlin/net/thauvin/erik/akismet" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/src/test/kotlin/net/thauvin/erik/akismet" isTestSource="true" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="module-library" scope="RUNTIME">
<library>
<CLASSES>
<root url="file://$MODULE_DIR$/src/main/resources/templates" />
</CLASSES>
<JAVADOC />
<SOURCES />
</library>
</orderEntry>
<orderEntry type="library" name="compile" level="project" />
<orderEntry type="library" scope="RUNTIME" name="runtime" level="project" />
<orderEntry type="library" scope="TEST" name="test" level="project" />
</component>
</module>

14
.idea/bld.iml generated Normal file
View file

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="JAVA_MODULE" version="4">
<component name="NewModuleRootManager">
<output url="file://$MODULE_DIR$/build/bld" />
<output-test url="file://$MODULE_DIR$/build/bld" />
<exclude-output />
<content url="file://$MODULE_DIR$/src/bld">
<sourceFolder url="file://$MODULE_DIR$/src/bld/java" isTestSource="false" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="bld" level="project" />
</component>
</module>

View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="Encoding">
<file url="PROJECT" charset="UTF-8" />
<component name="BldConfiguration">
<events />
</component>
</project>

View file

@ -1,15 +0,0 @@
<component name="ProjectCodeStyleConfiguration">
<code_scheme name="Project" version="173">
<JetCodeStyleSettings>
<option name="PACKAGES_TO_USE_STAR_IMPORTS">
<value />
</option>
<option name="NAME_COUNT_TO_USE_STAR_IMPORT" value="2147483647" />
<option name="NAME_COUNT_TO_USE_STAR_IMPORT_FOR_MEMBERS" value="2147483647" />
<option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
</JetCodeStyleSettings>
<codeStyleSettings language="kotlin">
<option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
</codeStyleSettings>
</code_scheme>
</component>

View file

@ -1,5 +0,0 @@
<component name="ProjectCodeStyleConfiguration">
<state>
<option name="USE_PER_PROJECT_SETTINGS" value="true" />
</state>
</component>

6
.idea/compiler.xml generated
View file

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="CompilerConfiguration">
<bytecodeTargetLevel target="11" />
</component>
</project>

6
.idea/copyright/BSD_3.xml generated Normal file
View file

@ -0,0 +1,6 @@
<component name="CopyrightManager">
<copyright>
<option name="notice" value="&amp;#36;file.fileName&#10;&#10;Copyright 2019-&amp;#36;today.year Erik C. Thauvin (erik@thauvin.net)&#10;&#10;Redistribution and use in source and binary forms, with or without&#10;modification, are permitted provided that the following conditions are met:&#10;&#10; Redistributions of source code must retain the above copyright notice, this&#10; list of conditions and the following disclaimer.&#10;&#10; Redistributions in binary form must reproduce the above copyright notice,&#10; this list of conditions and the following disclaimer in the documentation&#10; and/or other materials provided with the distribution.&#10;&#10; Neither the name of this project nor the names of its contributors may be&#10; used to endorse or promote products derived from this software without&#10; specific prior written permission.&#10;&#10;THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;&#10;AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE&#10;IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE&#10;DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE&#10;FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL&#10;DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR&#10;SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER&#10;CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,&#10;OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE&#10;OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." />
<option name="myName" value="BSD-3" />
</copyright>
</component>

View file

@ -1,6 +0,0 @@
<component name="CopyrightManager">
<copyright>
<option name="notice" value="&amp;#36;file.fileName&#10;&#10;Copyright (c) 2019-&amp;#36;today.year, Erik C. Thauvin (erik@thauvin.net)&#10;All rights reserved.&#10;&#10;Redistribution and use in source and binary forms, with or without&#10;modification, are permitted provided that the following conditions are met:&#10;&#10; Redistributions of source code must retain the above copyright notice, this&#10; list of conditions and the following disclaimer.&#10;&#10; Redistributions in binary form must reproduce the above copyright notice,&#10; this list of conditions and the following disclaimer in the documentation&#10; and/or other materials provided with the distribution.&#10;&#10; Neither the name of this project nor the names of its contributors may be&#10; used to endorse or promote products derived from this software without&#10; specific prior written permission.&#10;&#10;THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;&#10;AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE&#10;IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE&#10;DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE&#10;FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL&#10;DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR&#10;SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER&#10;CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,&#10;OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE&#10;OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." />
<option name="myName" value="Erik's Copyright Notice" />
</copyright>
</component>

View file

@ -1,3 +1,3 @@
<component name="CopyrightManager">
<settings default="Erik's Copyright Notice" />
<settings default="BSD-3" />
</component>

View file

@ -1,53 +1,8 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<option name="myLocal" value="true" />
<inspection_tool class="FieldMayBeFinal" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="JavaDoc" enabled="true" level="WARNING" enabled_by_default="true">
<option name="TOP_LEVEL_CLASS_OPTIONS">
<value>
<option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
<option name="REQUIRED_TAGS" value="" />
</value>
</option>
<option name="INNER_CLASS_OPTIONS">
<value>
<option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
<option name="REQUIRED_TAGS" value="" />
</value>
</option>
<option name="METHOD_OPTIONS">
<value>
<option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
<option name="REQUIRED_TAGS" value="@return@param@throws or @exception" />
</value>
</option>
<option name="FIELD_OPTIONS">
<value>
<option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
<option name="REQUIRED_TAGS" value="" />
</value>
</option>
<option name="IGNORE_DEPRECATED" value="false" />
<option name="IGNORE_JAVADOC_PERIOD" value="true" />
<option name="IGNORE_DUPLICATED_THROWS" value="false" />
<option name="IGNORE_POINT_TO_ITSELF" value="false" />
<option name="myAdditionalJavadocTags" value="created" />
</inspection_tool>
<inspection_tool class="LocalCanBeFinal" enabled="true" level="WARNING" enabled_by_default="true">
<option name="REPORT_VARIABLES" value="true" />
<option name="REPORT_PARAMETERS" value="false" />
<option name="REPORT_CATCH_PARAMETERS" value="false" />
</inspection_tool>
<inspection_tool class="LoggerInitializedWithForeignClass" enabled="false" level="WARNING" enabled_by_default="false">
<option name="loggerClassName" value="org.apache.log4j.Logger,org.slf4j.LoggerFactory,org.apache.commons.logging.LogFactory,java.util.logging.Logger" />
<option name="loggerFactoryMethodName" value="getLogger,getLogger,getLog,getLogger" />
</inspection_tool>
<inspection_tool class="UnnecessarySemicolon" enabled="false" level="WARNING" enabled_by_default="false" />
<inspection_tool class="WeakerAccess" enabled="true" level="WARNING" enabled_by_default="true">
<option name="SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS" value="true" />
<option name="SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES" value="false" />
<option name="SUGGEST_PRIVATE_FOR_INNERS" value="false" />
<inspection_tool class="JavadocDeclaration" enabled="true" level="WARNING" enabled_by_default="true">
<option name="ADDITIONAL_TAGS" value="created" />
</inspection_tool>
</profile>
</component>

View file

@ -1,50 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="RemoteRepositoriesConfiguration">
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Maven Central repository" />
<option name="url" value="https://repo1.maven.org/maven2" />
</remote-repository>
<remote-repository>
<option name="id" value="jboss.community" />
<option name="name" value="JBoss Community repository" />
<option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
</remote-repository>
<remote-repository>
<option name="id" value="BintrayJCenter" />
<option name="name" value="BintrayJCenter" />
<option name="url" value="https://jcenter.bintray.com/" />
</remote-repository>
<remote-repository>
<option name="id" value="MavenLocal" />
<option name="name" value="MavenLocal" />
<option name="url" value="file:/$MAVEN_REPOSITORY$/" />
</remote-repository>
<remote-repository>
<option name="id" value="MavenLocal" />
<option name="name" value="MavenLocal" />
<option name="url" value="file:$MAVEN_REPOSITORY$/" />
</remote-repository>
<remote-repository>
<option name="id" value="MavenRepo" />
<option name="name" value="MavenRepo" />
<option name="url" value="https://repo.maven.apache.org/maven2/" />
</remote-repository>
<remote-repository>
<option name="id" value="maven" />
<option name="name" value="maven" />
<option name="url" value="https://oss.sonatype.org/content/repositories/snapshots" />
</remote-repository>
<remote-repository>
<option name="id" value="maven" />
<option name="name" value="maven" />
<option name="url" value="https://packages.jetbrains.team/maven/p/ij/intellij-dependencies" />
</remote-repository>
<remote-repository>
<option name="id" value="MavenLocal" />
<option name="name" value="MavenLocal" />
<option name="url" value="file:$PROJECT_DIR$/../../maven/repository/" />
</remote-repository>
</component>
</project>

14
.idea/kotlinc.xml generated
View file

@ -1,6 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="Kotlin2JvmCompilerArguments">
<option name="jvmTarget" value="1.8" />
</component>
<component name="KotlinCommonCompilerArguments">
<option name="apiVersion" value="1.9" />
<option name="languageVersion" value="1.9" />
<option name="pluginClasspaths">
<array>
<option value="$KOTLIN_BUNDLED$/lib/kotlin-serialization-compiler-plugin.jar" />
</array>
</option>
</component>
<component name="KotlinJpsPluginSettings">
<option name="version" value="1.9.10" />
<option name="version" value="2.0.0" />
</component>
</project>

18
.idea/libraries/bld.xml generated Normal file
View file

@ -0,0 +1,18 @@
<component name="libraryTable">
<library name="bld">
<CLASSES>
<root url="file://$PROJECT_DIR$/lib/bld" />
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" />
</CLASSES>
<JAVADOC />
<SOURCES>
<root url="file://$PROJECT_DIR$/lib/bld" />
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
</SOURCES>
<excluded>
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
</excluded>
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" />
</library>
</component>

17
.idea/libraries/compile.xml generated Normal file
View file

@ -0,0 +1,17 @@
<component name="libraryTable">
<library name="compile">
<CLASSES>
<root url="file://$PROJECT_DIR$/lib/compile" />
<root url="file://$PROJECT_DIR$/lib/provided" />
</CLASSES>
<JAVADOC />
<SOURCES>
<root url="file://$PROJECT_DIR$/lib/compile" />
<root url="file://$PROJECT_DIR$/lib/provided" />
</SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" />
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="true" type="SOURCES" />
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="true" />
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="true" type="SOURCES" />
</library>
</component>

14
.idea/libraries/runtime.xml generated Normal file
View file

@ -0,0 +1,14 @@
<component name="libraryTable">
<library name="runtime">
<CLASSES>
<root url="file://$PROJECT_DIR$/lib/runtime" />
<root url="file://$PROJECT_DIR$/src/main/resources" />
</CLASSES>
<JAVADOC />
<SOURCES>
<root url="file://$PROJECT_DIR$/lib/runtime" />
</SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" />
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="true" type="SOURCES" />
</library>
</component>

18
.idea/libraries/test.xml generated Normal file
View file

@ -0,0 +1,18 @@
<component name="libraryTable">
<library name="test">
<CLASSES>
<root url="file://$PROJECT_DIR$/lib/test" />
<root url="file://$PROJECT_DIR$/lib/provided" />
<root url="file://$PROJECT_DIR$/src/test/resources" />
</CLASSES>
<JAVADOC />
<SOURCES>
<root url="file://$PROJECT_DIR$/lib/test" />
<root url="file://$PROJECT_DIR$/lib/provided" />
</SOURCES>
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" />
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="true" type="SOURCES" />
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="true" />
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="true" type="SOURCES" />
</library>
</component>

25
.idea/misc.xml generated
View file

@ -1,21 +1,12 @@
<project version="4">
<component name="AnalysisProjectProfileManager">
<option name="PROJECT_PROFILE" />
<option name="USE_PROJECT_LEVEL_SETTINGS" value="false" />
<list size="0" />
<component name="EntryPointsManager">
<pattern value="net.thauvin.erik.AkismetBuild" />
<pattern value="net.thauvin.erik.AkismetBuild" method="docs" />
<pattern value="net.thauvin.erik.AkismetBuild" method="jacoco" />
<pattern value="net.thauvin.erik.AkismetBuild" method="detekt" />
<pattern value="net.thauvin.erik.AkismetBuild" method="detektBaseline" />
</component>
<component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" />
</component>
<component name="JavaScriptSettings">
<option name="languageLevel" value="ES6" />
</component>
<component name="PDMPlugin">
<option name="skipTestSources" value="false" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="18" project-jdk-type="JavaSDK" />
<component name="SuppressionsComponent">
<option name="suppComments" value="[]" />
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" project-jdk-name="17" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/build" />
</component>
</project>

9
.idea/modules.xml generated Normal file
View file

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/app.iml" filepath="$PROJECT_DIR$/.idea/app.iml" />
<module fileurl="file://$PROJECT_DIR$/.idea/bld.iml" filepath="$PROJECT_DIR$/.idea/bld.iml" />
</modules>
</component>
</project>

9
.idea/runConfigurations/Run Tests.xml generated Normal file
View file

@ -0,0 +1,9 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Run Tests" type="Application" factoryName="Application" nameIsGenerated="true">
<option name="MAIN_CLASS_NAME" value="net.thauvin.erik.AkismetTest" />
<module name="app" />
<method v="2">
<option name="Make" enabled="true" />
</method>
</configuration>
</component>

View file

@ -1,4 +1,4 @@
Copyright (c) 2019-2022, Erik C. Thauvin (erik@thauvin.net)
Copyright (c) 2019-2025, Erik C. Thauvin (erik@thauvin.net)
All rights reserved.
Redistribution and use in source and binary forms, with or without

View file

@ -1,11 +1,12 @@
[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.10-7f52ff)](https://kotlinlang.org/)
[![Kotlin](https://img.shields.io/badge/kotlin-2.1.20-7f52ff)](https://kotlinlang.org/)
[![bld](https://img.shields.io/badge/2.2.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld)
[![Release](https://img.shields.io/github/release/ethauvin/akismet-kotlin.svg)](https://github.com/ethauvin/akismet-kotlin/releases/latest)
[![Nexus Snapshot](https://img.shields.io/nexus/s/net.thauvin.erik/akismet-kotlin?label=snapshot&server=https%3A%2F%2Foss.sonatype.org%2F)](https://oss.sonatype.org/content/repositories/snapshots/net/thauvin/erik/akismet-kotlin/)
[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/akismet-kotlin.svg?color=blue)](https://central.sonatype.com/artifact/net.thauvin.erik/akismet-kotlin)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_akismet-kotlin&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_akismet-kotlin)
[![GitHub CI](https://github.com/ethauvin/akismet-kotlin/actions/workflows/gradle.yml/badge.svg)](https://github.com/ethauvin/akismet-kotlin/actions/workflows/gradle.yml)
[![GitHub CI](https://github.com/ethauvin/akismet-kotlin/actions/workflows/bld.yml/badge.svg)](https://github.com/ethauvin/akismet-kotlin/actions/workflows/bld.yml)
[![CircleCI](https://circleci.com/gh/ethauvin/akismet-kotlin/tree/master.svg?style=shield)](https://circleci.com/gh/ethauvin/akismet-kotlin/tree/master)
# [Akismet](https://www.akismet.com) for Kotlin, Java and Android
@ -14,20 +15,18 @@ A pretty complete and straightforward implementation of the [Automattic's Akisme
## Examples (TL;DR)
#### Kotlin
### Kotlin
```kotlin
val akismet = Akismet(apiKey = "YOUR_API_KEY", blog = "YOUR_BLOG_URL")
val comment = AkismetComment(userIp = "127.0.0.1", userAgent = "curl/7.29.0")
with(comment) {
val comment = AkismetComment(userIp = "127.0.0.1", userAgent = "curl/7.29.0").apply {
referrer = "https://www.google.com"
type = AkismetComment.TYPE_COMMENT
type = CommentType.COMMENT
author = "admin"
authorEmail = "test@test.com"
authorUrl = "https://www.CheckOutMyCoolSite.com"
dateGmt = Akismet.dateToGmt(Date())
content = "It means a lot that you would take the time to review our software."
content = "Thanks for reviewing our software."
}
// ...
@ -37,21 +36,23 @@ if (isSpam) {
}
```
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/kotlin/com/example/AkismetExample.kt)
[View Full Examples](https://github.com/ethauvin/akismet-kotlin/blob/master/examples)
#### Java
### Java
```java
final Akismet akismet = new Akismet("YOUR_API_KEY", "YOUR_BLOG_URL");
final AkismetComment comment = new AkismetComment("127.0.0.1", "curl/7.29.0");
comment.setReferrer("https://www.google.com");
comment.setType(AkismetComment.TYPE_COMMENT);
comment.setAuthor("admin");
comment.setAuthorEmail("test@test.com");
comment.setAuthorUrl("https://www.CheckOutMyCoolSite.com");
comment.setDateGmt(Akismet.dateToGmt(new Date()));
comment.setContent("It means a lot that you would take the time to review our software.");
final AkismetComment comment = new AkismetComment(
new CommentConfig.Builder("127.0.0.1", "curl/7.29.0")
.referrer("https://www.google.com")
.type(CommentType.COMMENT)
.author("admin")
.authorEmail("test@test.com")
.authorUrl("https://www.CheckOutMyCoolSite.com")
.dateGmt(Akismet.dateToGmt(new Date()))
.content("Thanks for reviewing our software.")
.build
);
//...
final boolean isSpam = akismet.checkComment(comment);
@ -60,11 +61,22 @@ if (isSpam) {
}
```
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/java/com/example/AkismetSample.java)
[View Full Examples](https://github.com/ethauvin/akismet-kotlin/blob/master/examples)
### Gradle
## bld
To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/build.gradle.kts) file:
To use with [bld](https://rife2.com/bld), include the following dependency in your [build](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/bld/src/bld/java/com/example/ExampleBuild.java) file:
```java
repositories = List.of(MAVEN_CENTRAL, SONATYPE_SNAPSHOTS_LEGACY);
scope(compile)
.include(dependency("net.thauvin.erik:akismet-kotlin:1.1.0-SNAPSHOT"));
```
## Gradle
To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/gradle/build.gradle.kts) file:
```gradle
repositories {
@ -72,13 +84,13 @@ repositories {
}
dependencies {
implementation("net.thauvin.erik:akismet-kotlin:1.0.0")
implementation("net.thauvin.erik:akismet-kotlin:1.1.0-SNAPSHOT")
}
```
Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://central.sonatype.com/artifact/net.thauvin.erik/akismet-kotlin).
### HttpServletRequest
## HttpServletRequest
The more information is sent to Akismet, the more accurate the response is. An [HttpServletRequest](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html) can be used as a parameter so that all the relevant information is automatically included.
@ -88,9 +100,9 @@ AkismetComment(request = context.getRequest())
This will ensure that the user's IP, agent, referrer and various environment variables are automatically extracted from the request.
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/kotlin/com/example/AkismetServlet.kt)
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/gradle/src/main/kotlin/com/example/AkismetServlet.kt)
### JSON
## JSON
Since comments mis-identified as spam or ham can be submitted to Askimet to improve the service. A comment can be saved as a JSON object to be stored in a database, etc.
@ -104,5 +116,24 @@ At a latter time, the comment can then be submitted:
akismet.submitSpam(Akismet.jsonComment(json))
```
### More...
## Contributing
If you want to contribute to this project, all you have to do is clone the GitHub
repository:
```console
git clone git@github.com:ethauvin/akismet-kotlin.git
```
Then use [bld](https://rife2.com/bld) to build:
```console
cd akismet-kotlin
./bld compile
```
The project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all the dependencies were downloaded and peruse the code.
### More…
If all else fails, there's always more [Documentation](https://ethauvin.github.io/akismet-kotlin/).

View file

@ -1,9 +1,20 @@
image: maven:3-openjdk-18
image: ubuntu:latest
pipelines:
default:
- step:
caches:
- gradle
name: Test with bld
script:
- bash ./gradlew check
# Install latest Java & Kotlin via SDKMAN!
- apt-get update -qq && apt-get install -y curl zip
- curl -s "https://get.sdkman.io" | bash
- echo sdkman_auto_answer=true > $HOME/.sdkman/etc/config
- echo sdkman_auto_selfupdate=true >> $HOME/.sdkman/etc/config
- source "$HOME/.sdkman/bin/sdkman-init.sh"
- sdk install java
- sdk install kotlin
- source "$HOME/.sdkman/bin/sdkman-init.sh"
# Download, compile and test with bld
- ./bld download
- ./bld compile
- ./bld test

2
bld Executable file
View file

@ -0,0 +1,2 @@
#!/usr/bin/env sh
java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build net.thauvin.erik.AkismetBuild "$@"

4
bld.bat Normal file
View file

@ -0,0 +1,4 @@
@echo off
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build net.thauvin.erik.AkismetBuild %*

View file

@ -1,272 +0,0 @@
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import java.net.URL
import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask
import org.gradle.api.tasks.testing.logging.TestExceptionFormat
import org.gradle.api.tasks.testing.logging.TestLogEvent
plugins {
id("com.github.ben-manes.versions") version "0.48.0"
id("io.gitlab.arturbosch.detekt") version "1.23.1"
id("java-library")
id("java")
id("maven-publish")
id("net.thauvin.erik.gradle.semver") version "1.0.4"
id("org.jetbrains.dokka") version "1.9.0"
id("org.jetbrains.kotlinx.kover") version "0.7.3"
id("org.sonarqube") version "4.3.1.3277"
id("signing")
kotlin("jvm") version "1.9.10"
kotlin("kapt") version "1.9.10"
kotlin("plugin.serialization") version "1.9.10"
}
group = "net.thauvin.erik"
description = "A client library for accessing the Automattic Kismet (Akismet) spam comments filtering service."
val gitHub = "ethauvin/$name"
val mavenUrl = "https://github.com/$gitHub"
val deployDir = "deploy"
var isRelease = "release" in gradle.startParameter.taskNames
var semverProcessor = "net.thauvin.erik:semver:1.2.0"
val publicationName = "mavenJava"
object Versions {
const val OKHTTP = "4.11.0"
}
fun isNonStable(version: String): Boolean {
val stableKeyword = listOf("RELEASE", "FINAL", "GA").any { version.uppercase().contains(it) }
val regex = "^[0-9,.v-]+(-r)?$".toRegex()
val isStable = stableKeyword || regex.matches(version)
return isStable.not()
}
repositories {
mavenCentral()
maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") }
}
dependencies {
kapt(semverProcessor)
compileOnly(semverProcessor)
implementation(platform("org.jetbrains.kotlin:kotlin-bom"))
// implementation("javax.servlet:javax.servlet-api:4.0.1")
implementation("jakarta.servlet:jakarta.servlet-api:6.0.0")
implementation("com.squareup.okhttp3:okhttp:${Versions.OKHTTP}")
implementation("com.squareup.okio:okio:3.5.0")
implementation("com.squareup.okhttp3:logging-interceptor:${Versions.OKHTTP}")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.0")
testImplementation("org.mockito:mockito-core:5.5.0")
testImplementation("org.testng:testng:7.8.0")
testImplementation("com.willowtreeapps.assertk:assertk-jvm:0.27.0")
}
kapt {
arguments {
arg("semver.project.dir", projectDir)
}
}
detekt {
//toolVersion = "main-SNAPSHOT"
baseline = project.rootDir.resolve("config/detekt/baseline.xml")
}
java {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
withSourcesJar()
}
koverReport {
defaults {
xml {
onCheck = true
}
html {
onCheck = true
}
}
}
sonarqube {
properties {
property("sonar.projectKey", "ethauvin_$name")
property("sonar.organization", "ethauvin-github")
property("sonar.host.url", "https://sonarcloud.io")
property("sonar.sourceEncoding", "UTF-8")
property("sonar.coverage.jacoco.xmlReportPaths", "${layout.buildDirectory.get()}/reports/kover/report.xml")
}
}
val javadocJar by tasks.creating(Jar::class) {
dependsOn(tasks.dokkaJavadoc)
from(tasks.dokkaJavadoc)
archiveClassifier.set("javadoc")
description = "Assembles a JAR of the generated Javadoc."
group = JavaBasePlugin.DOCUMENTATION_GROUP
}
tasks {
withType<Test> {
testLogging {
exceptionFormat = TestExceptionFormat.FULL
events = setOf(TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED)
}
useTestNG()
}
withType<KotlinCompile>().configureEach {
kotlinOptions.jvmTarget = java.targetCompatibility.toString()
}
withType<GenerateMavenPom> {
destination = file("$projectDir/pom.xml")
}
withType<DependencyUpdatesTask> {
rejectVersionIf {
isNonStable(candidate.version)
}
}
assemble {
dependsOn(javadocJar)
}
clean {
doLast {
project.delete(fileTree(deployDir))
}
}
dokkaHtml {
outputDirectory.set(file("$projectDir/docs"))
dokkaSourceSets {
configureEach {
includes.from("config/dokka/packages.md")
sourceLink {
localDirectory.set(file("src/main/kotlin/"))
remoteUrl.set(URL("https://github.com/ethauvin/${project.name}/tree/master/src/main/kotlin/"))
remoteLineSuffix.set("#L")
}
externalDocumentationLink {
url.set(URL("https://jakarta.ee/specifications/platform/9/apidocs/"))
}
}
}
}
dokkaJavadoc {
dependsOn("kaptKotlin")
dokkaSourceSets {
configureEach {
includes.from("config/dokka/packages.md")
externalDocumentationLink {
url.set(URL("https://jakarta.ee/specifications/platform/9/apidocs/"))
}
}
}
}
val copyToDeploy by registering(Copy::class) {
from(configurations.runtimeClasspath) {
exclude("annotations-*.jar", "jakarta.servlet-*.jar")
}
from(jar)
into(deployDir)
}
register("deploy") {
description = "Copies all needed files to the $deployDir directory."
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(clean, build, jar)
outputs.dir(deployDir)
inputs.files(copyToDeploy)
mustRunAfter(clean)
}
val gitIsDirty by registering(Exec::class) {
description = "Fails if git has uncommitted changes."
group = "verification"
commandLine("git", "diff", "--quiet", "--exit-code")
}
val gitTag by registering(Exec::class) {
description = "Tags the local repository with version ${project.version}"
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(gitIsDirty)
if (isRelease) {
commandLine("git", "tag", "-a", project.version, "-m", "Version ${project.version}")
}
}
register("release") {
description = "Publishes version ${project.version} to local repository."
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(dokkaHtml, "deploy", gitTag, publishToMavenLocal)
}
}
publishing {
publications {
create<MavenPublication>(publicationName) {
from(components["java"])
artifact(javadocJar)
pom {
name.set(project.name)
description.set(project.description)
url.set(mavenUrl)
licenses {
license {
name.set("BSD 3-Clause")
url.set("https://opensource.org/licenses/BSD-3-Clause")
}
}
developers {
developer {
id.set("ethauvin")
name.set("Erik C. Thauvin")
email.set("erik@thauvin.net")
url.set("https://erik.thauvin.net/")
}
}
scm {
connection.set("scm:git:https://github.com/$gitHub.git")
developerConnection.set("scm:git:git@github.com:$gitHub.git")
url.set(mavenUrl)
}
issueManagement {
system.set("GitHub")
url.set("$mavenUrl/issues")
}
}
}
}
repositories {
maven {
name = "ossrh"
project.afterEvaluate {
url = if (project.version.toString().contains("SNAPSHOT"))
uri("https://oss.sonatype.org/content/repositories/snapshots/") else
uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
}
credentials(PasswordCredentials::class)
}
}
}
signing {
useGpgCmd()
sign(publishing.publications[publicationName])
}

View file

@ -1,13 +1,17 @@
<?xml version='1.0' encoding='UTF-8'?>
<?xml version="1.0" ?>
<SmellBaseline>
<ManuallySuppressedIssues/>
<ManuallySuppressedIssues></ManuallySuppressedIssues>
<CurrentIssues>
<ID>CyclomaticComplexMethod:Akismet.kt$Akismet$private fun buildFormBody(comment: AkismetComment): FormBody</ID>
<ID>CyclomaticComplexMethod:AkismetComment.kt$AkismetComment$@Suppress("DuplicatedCode") override fun equals(other: Any?): Boolean</ID>
<ID>LongParameterList:AkismetServlet.kt$AkismetServlet$( id: String, name: String?, email: String?, date: String?, comment: String?, json: String, isSpam: Boolean )</ID>
<ID>MagicNumber:Akismet.kt$Akismet$12</ID>
<ID>MagicNumber:Akismet.kt$Akismet$8</ID>
<ID>NestedBlockDepth:Akismet.kt$Akismet$@JvmOverloads fun executeMethod(apiUrl: HttpUrl, formBody: FormBody, trueOnError: Boolean = false): Boolean</ID>
<ID>NestedBlockDepth:AkismetExample.kt$fun main(args: Array&lt;String&gt;)</ID>
<ID>NestedBlockDepth:AkismetTest.kt$fun getKey(key: String): String</ID>
<ID>ReturnCount:Akismet.kt$Akismet$@JvmOverloads fun executeMethod(apiUrl: HttpUrl, formBody: FormBody, trueOnError: Boolean = false): Boolean</ID>
<ID>TooManyFunctions:CommentConfig.kt$CommentConfig$Builder</ID>
<ID>WildcardImport:AkismetTest.kt$import assertk.assertions.*</ID>
</CurrentIssues>
</SmellBaseline>

View file

@ -2,7 +2,7 @@
[Akismet for Kotlin/Java](https://github.com/ethauvin/akismet-kotlin), a client library for accessing the [Automattic Kismet](https://www.akismet.com/) (Akismet) spam comments filtering service.
# package net.thauvin.erik.akismet
# Package net.thauvin.erik.akismet
A Kotlin/Java library for accessing the Akismet service.

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>AkismetComment</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/AkismetComment/#jakarta.servlet.http.HttpServletRequest/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">AkismetComment</span></div>
<div class="cover ">
<h1 class="cover"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L212">source</a>)</span></span></div><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="server-env.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>serverEnv</span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><a href="../-comment-config/index.html">CommentConfig</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L228">source</a>)</span></span></div><br><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L59">source</a>)</span></span></div><p class="paragraph">Creates a new instance.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/ADMIN_ROLE/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">ADMIN_ROLE</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/ADMIN_ROLE/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">ADMIN_ROLE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>ADMIN_ROLE</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L94">source</a>)</span></span></div><p class="paragraph">Administrator role. If used, Akismet will always return false.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L64">source</a>)</span></span></div><p class="paragraph">Administrator role. If used, Akismet will always return <code class="lang-kotlin">false</code>.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_BLOG_POST/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_BLOG_POST</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_BLOG_POST/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_BLOG_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_BLOG_POST</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L73">source</a>)</span></span></div><p class="paragraph">A blog post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L71">source</a>)</span></span></div><p class="paragraph">A blog post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_COMMENT/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_COMMENT</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_COMMENT/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_COMMENT</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_COMMENT</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L64">source</a>)</span></span></div><p class="paragraph">A blog comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L62">source</a>)</span></span></div><p class="paragraph">A blog comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_CONTACT_FORM/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_CONTACT_FORM</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_CONTACT_FORM/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_CONTACT_FORM</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_CONTACT_FORM</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L76">source</a>)</span></span></div><p class="paragraph">A contact form or feedback form submission.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L74">source</a>)</span></span></div><p class="paragraph">A contact form or feedback form submission.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_FORUM_POST/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_FORUM_POST</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_FORUM_POST/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_FORUM_POST</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_FORUM_POST</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L67">source</a>)</span></span></div><p class="paragraph">A top-level forum post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L65">source</a>)</span></span></div><p class="paragraph">A top-level forum post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_MESSAGE/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_MESSAGE</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_MESSAGE/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_MESSAGE</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_MESSAGE</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L82">source</a>)</span></span></div><p class="paragraph">A message sent between just a few users.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L80">source</a>)</span></span></div><p class="paragraph">A message sent between just a few users.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_PINGBACK/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_PINGBACK</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_PINGBACK/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_PINGBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_PINGBACK</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L85">source</a>)</span></span></div><p class="paragraph">A pingback.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L83">source</a>)</span></span></div><p class="paragraph">A pingback.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_REPLY/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_REPLY</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_REPLY/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_REPLY</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_REPLY</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L70">source</a>)</span></span></div><p class="paragraph">A reply to a top-level forum post.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L68">source</a>)</span></span></div><p class="paragraph">A reply to a top-level forum post.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_SIGNUP/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_SIGNUP</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_SIGNUP/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_SIGNUP</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_SIGNUP</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L79">source</a>)</span></span></div><p class="paragraph">A new user account.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L77">source</a>)</span></span></div><p class="paragraph">A new user account.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TRACKBACK/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TRACKBACK</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TRACKBACK/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TRACKBACK</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_TRACKBACK</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L88">source</a>)</span></span></div><p class="paragraph">A trackback.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L86">source</a>)</span></span></div><p class="paragraph">A trackback.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TWEET</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion/TYPE_TWEET/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">TYPE_TWEET</span></div>
<div class="cover ">
<h1 class="cover"><span><span>TYPE_TWEET</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L91">source</a>)</span></span></div><p class="paragraph">A Twitter message.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L89">source</a>)</span></span></div><p class="paragraph">A Twitter message.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -0,0 +1,104 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Companion</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment.Companion///PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">Companion</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Companion</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1816802345%2FProperties%2F-1617659094" anchor-label="ADMIN_ROLE" id="-1816802345%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-d-m-i-n_-r-o-l-e.html"><span><span>ADMIN_ROLE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1816802345%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Administrator role. If used, Akismet will always return <code class="lang-kotlin">false</code>.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorEmail/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorEmail</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/authorEmail/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorEmail</span></div>
<div class="cover ">
<h1 class="cover"><span>author</span><wbr></wbr><span><span>Email</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L139">source</a>)</span></span></div><p class="paragraph">Email address submitted with the comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L114">source</a>)</span></span></div><p class="paragraph">Email address submitted with the comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/authorUrl/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorUrl</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/authorUrl/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">authorUrl</span></div>
<div class="cover ">
<h1 class="cover"><span>author</span><wbr></wbr><span><span>Url</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L145">source</a>)</span></span></div><p class="paragraph">URL submitted with comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L122">source</a>)</span></span></div><p class="paragraph">URL submitted with comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/author/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">author</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/author/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">author</span></div>
<div class="cover ">
<h1 class="cover"><span><span>author</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L133">source</a>)</span></span></div><p class="paragraph">Name submitted with the comment.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L106">source</a>)</span></span></div><p class="paragraph">Name submitted with the comment.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogCharset/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogCharset</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/blogCharset/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogCharset</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Charset</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L191">source</a>)</span></span></div><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L170">source</a>)</span></span></div><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/blogLang/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogLang</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/blogLang/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">blogLang</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Lang</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L183">source</a>)</span></span></div><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p><p class="paragraph">A site with articles in English and French might use: <code class="lang-kotlin">en, fr_ca</code></p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L162">source</a>)</span></span></div><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p><p class="paragraph">A site with articles in English and French might use: <code class="lang-kotlin">en, fr_ca</code></p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/content/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">content</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/content/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">content</span></div>
<div class="cover ">
<h1 class="cover"><span><span>content</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L151">source</a>)</span></span></div><p class="paragraph">The content that was submitted.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L130">source</a>)</span></span></div><p class="paragraph">The content that was submitted.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/dateGmt/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">dateGmt</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/dateGmt/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">dateGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>date</span><wbr></wbr><span><span>Gmt</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L163">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p><p class="paragraph">May be omitted if the comment is sent to the API at the time it is created.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L142">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p><p class="paragraph">May be omitted if the comment is sent to the API at the time it is created.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/equals/#kotlin.Any?/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">equals</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/equals/#kotlin.Any?/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">equals</span></div>
<div class="cover ">
<h1 class="cover"><span><span>equals</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L270">source</a>)</span></span></div><p class="paragraph">Indicates whether some other object is <i>equal to</i> this one.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L268">source</a>)</span></span></div><p class="paragraph">Indicates whether some other object is <i>equal to</i> this one.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/hashCode/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">hashCode</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/hashCode/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">hashCode</span></div>
<div class="cover ">
<h1 class="cover"><span>hash</span><wbr></wbr><span><span>Code</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L301">source</a>)</span></span></div><p class="paragraph">Returns a hash code value for the object.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L299">source</a>)</span></span></div><p class="paragraph">Returns a hash code value for the object.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -0,0 +1,446 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>AkismetComment</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment///PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><span class="current">AkismetComment</span></div>
<div class="cover ">
<h1 class="cover"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">AkismetComment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L59">source</a>)</span></span></div><p class="paragraph">A comment to send to Akismet.</p><p class="paragraph">Most everything is optional. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-1694972560%2FConstructors%2F-1617659094" anchor-label="AkismetComment" id="-1694972560%2FConstructors%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet-comment.html"><span>Akismet</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1694972560%2FConstructors%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">request<span class="token operator">: </span><a href="https://jakarta.ee/specifications/platform/9/apidocs/jakarta/servlet/http/HttpServletRequest.html">HttpServletRequest</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance extracting the <a href="user-ip.html">userIp</a>, <a href="user-agent.html">userAgent</a>, <a href="referrer.html">referrer</a> and <a href="server-env.html">serverEnv</a> environment variables from a Servlet request.</p></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><a href="../-comment-config/index.html">CommentConfig</a></span></span><span class="token punctuation">)</span></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="598470178%2FClasslikes%2F-1617659094" anchor-label="Companion" id="598470178%2FClasslikes%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="598470178%2FClasslikes%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="332140596%2FProperties%2F-1617659094" anchor-label="author" id="332140596%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author.html"><span><span>author</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="332140596%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Name submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="763933098%2FProperties%2F-1617659094" anchor-label="authorEmail" id="763933098%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-email.html"><span>author</span><wbr></wbr><span><span>Email</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="763933098%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Email address submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1877068151%2FProperties%2F-1617659094" anchor-label="authorUrl" id="1877068151%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-url.html"><span>author</span><wbr></wbr><span><span>Url</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1877068151%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">URL submitted with comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="351987025%2FProperties%2F-1617659094" anchor-label="blogCharset" id="351987025%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-charset.html"><span>blog</span><wbr></wbr><span><span>Charset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="351987025%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1858576431%2FProperties%2F-1617659094" anchor-label="blogLang" id="1858576431%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-lang.html"><span>blog</span><wbr></wbr><span><span>Lang</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1858576431%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-166043134%2FProperties%2F-1617659094" anchor-label="content" id="-166043134%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content.html"><span><span>content</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-166043134%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The content that was submitted.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-2145557861%2FProperties%2F-1617659094" anchor-label="dateGmt" id="-2145557861%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-gmt.html"><span>date</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2145557861%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The UTC timestamp of the creation of the comment, in ISO 8601 format.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1505739261%2FProperties%2F-1617659094" anchor-label="isTest" id="-1505739261%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-test.html"><span>is</span><wbr></wbr><span><span>Test</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1505739261%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1733570640%2FProperties%2F-1617659094" anchor-label="permalink" id="1733570640%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="permalink.html"><span><span>permalink</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1733570640%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="981159414%2FProperties%2F-1617659094" anchor-label="postModifiedGmt" id="981159414%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="post-modified-gmt.html"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="981159414%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1133067614%2FProperties%2F-1617659094" anchor-label="recheckReason" id="-1133067614%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="recheck-reason.html"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1133067614%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="94610336%2FProperties%2F-1617659094" anchor-label="referrer" id="94610336%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="referrer.html"><span><span>referrer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="94610336%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The content of the referer header should be set here.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="208017777%2FProperties%2F-1617659094" anchor-label="serverEnv" id="208017777%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="server-env.html"><span>server</span><wbr></wbr><span><span>Env</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="208017777%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-136735259%2FProperties%2F-1617659094" anchor-label="type" id="-136735259%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-136735259%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../-comment-type/index.html">CommentType</a></div><div class="brief "><p class="paragraph">A string that describes the type of content being sent, such as:</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1645403169%2FProperties%2F-1617659094" anchor-label="userAgent" id="1645403169%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-agent.html"><span>user</span><wbr></wbr><span><span>Agent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1645403169%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="727916877%2FProperties%2F-1617659094" anchor-label="userIp" id="727916877%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-ip.html"><span>user</span><wbr></wbr><span><span>Ip</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="727916877%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1651039006%2FProperties%2F-1617659094" anchor-label="userRole" id="1651039006%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-role.html"><span>user</span><wbr></wbr><span><span>Role</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1651039006%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1602627458%2FFunctions%2F-1617659094" anchor-label="equals" id="1602627458%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="equals.html"><span><span>equals</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1602627458%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="equals.html"><span class="token function">equals</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Indicates whether some other object is <i>equal to</i> this one.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1389700900%2FFunctions%2F-1617659094" anchor-label="hashCode" id="1389700900%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="hash-code.html"><span>hash</span><wbr></wbr><span><span>Code</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1389700900%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="hash-code.html"><span class="token function">hashCode</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Returns a hash code value for the object.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="662793916%2FFunctions%2F-1617659094" anchor-label="toJson" id="662793916%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-json.html"><span>to</span><wbr></wbr><span><span>Json</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="662793916%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1211534835%2FFunctions%2F-1617659094" anchor-label="toString" id="1211534835%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-string.html"><span>to</span><wbr></wbr><span><span>String</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1211534835%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Returns a JSON representation of the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/isTest/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">isTest</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/isTest/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">isTest</span></div>
<div class="cover ">
<h1 class="cover"><span>is</span><wbr></wbr><span><span>Test</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L207">source</a>)</span></span></div><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L188">source</a>)</span></span></div><p class="paragraph">This is an optional parameter. You can use it when submitting test queries to Akismet.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/permalink/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">permalink</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/permalink/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">permalink</span></div>
<div class="cover ">
<h1 class="cover"><span><span>permalink</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L104">source</a>)</span></span></div><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L78">source</a>)</span></span></div><p class="paragraph">The full permanent URL of the entry the comment was submitted to.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/postModifiedGmt/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">postModifiedGmt</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/postModifiedGmt/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">postModifiedGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L173">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L152">source</a>)</span></span></div><p class="paragraph">The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/recheckReason/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">recheckReason</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/recheckReason/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">recheckReason</span></div>
<div class="cover ">
<h1 class="cover"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L216">source</a>)</span></span></div><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p><p class="paragraph">For example: <code class="lang-kotlin">edit</code></p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L197">source</a>)</span></span></div><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p><p class="paragraph">For example: <code class="lang-kotlin">edit</code></p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/referrer/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">referrer</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/referrer/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">referrer</span></div>
<div class="cover ">
<h1 class="cover"><span><span>referrer</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L98">source</a>)</span></span></div><p class="paragraph">The content of the referer header should be set here.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L70">source</a>)</span></span></div><p class="paragraph">The content of the referer header should be set here.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/serverEnv/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">serverEnv</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/serverEnv/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">serverEnv</span></div>
<div class="cover ">
<h1 class="cover"><span>server</span><wbr></wbr><span><span>Env</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L229">source</a>)</span></span></div><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p><p class="paragraph">How the submitted content interacts with the server can be very telling, so please include as much of it as possible.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L210">source</a>)</span></span></div><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p><p class="paragraph">How the submitted content interacts with the server can be very telling, so please include as much of it as possible.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toJson/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toJson</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/toJson/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toJson</span></div>
<div class="cover ">
<h1 class="cover"><span>to</span><wbr></wbr><span><span>Json</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L253">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="to-json.html"><span class="token function">toJson</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L251">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/toString/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toString</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/toString/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">toString</span></div>
<div class="cover ">
<h1 class="cover"><span>to</span><wbr></wbr><span><span>String</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L262">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="to-string.html"><span class="token function">toString</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L260">source</a>)</span></span></div><p class="paragraph">Returns a JSON representation of the comment.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-akismet/-companion/json-comment.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/type/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">type</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/type/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">type</span></div>
<div class="cover ">
<h1 class="cover"><span><span>type</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L127">source</a>)</span></span></div><p class="paragraph">A string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-m-m-e-n-t.html">TYPE_COMMENT</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-f-o-r-u-m_-p-o-s-t.html">TYPE_FORUM_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-r-e-p-l-y.html">TYPE_REPLY</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-b-l-o-g_-p-o-s-t.html">TYPE_BLOG_POST</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-c-o-n-t-a-c-t_-f-o-r-m.html">TYPE_CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-s-i-g-n-u-p.html">TYPE_SIGNUP</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-m-e-s-s-a-g-e.html">TYPE_MESSAGE</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-p-i-n-g-b-a-c-k.html">TYPE_PINGBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-r-a-c-k-b-a-c-k.html">TYPE_TRACKBACK</a></p></li><li><p class="paragraph"><a href="-companion/-t-y-p-e_-t-w-e-e-t.html">TYPE_TWEET</a></p></li></ul><p class="paragraph">You may send a value not listed above if none of them accurately describe your content.</p><p class="paragraph">This is further explained <a href="http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/">here</a>.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../-comment-type/index.html">CommentType</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L101">source</a>)</span></span></div><p class="paragraph">A string that describes the type of content being sent, such as:</p><ul><li><p class="paragraph"><a href="../-comment-type/-companion/-c-o-m-m-e-n-t.html">CommentType.COMMENT</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-f-o-r-u-m_-p-o-s-t.html">CommentType.FORUM_POST</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-r-e-p-l-y.html">CommentType.REPLY</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-b-l-o-g_-p-o-s-t.html">CommentType.BLOG_POST</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-c-o-n-t-a-c-t_-f-o-r-m.html">CommentType.CONTACT_FORM</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-s-i-g-n-u-p.html">CommentType.SIGNUP</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-m-e-s-s-a-g-e.html">CommentType.MESSAGE</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-p-i-n-g-b-a-c-k.html">CommentType.PINGBACK</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-t-r-a-c-k-b-a-c-k.html">CommentType.TRACKBACK</a></p></li><li><p class="paragraph"><a href="../-comment-type/-companion/-t-w-e-e-t.html">CommentType.TWEET</a></p></li></ul><p class="paragraph">You may send a value not listed above if none of them accurately describe your content.</p><p class="paragraph">This is further explained <a href="http://blog.akismet.com/2012/06/19/pro-tip-tell-us-your-comment_type/">here</a>.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userAgent/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userAgent</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/userAgent/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userAgent</span></div>
<div class="cover ">
<h1 class="cover"><span>user</span><wbr></wbr><span><span>Agent</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L59">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userIp/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userIp</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/userIp/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userIp</span></div>
<div class="cover ">
<h1 class="cover"><span>user</span><wbr></wbr><span><span>Ip</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L60">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L59">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/AkismetComment/userRole/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userRole</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/AkismetComment/userRole/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">AkismetComment</a><span class="delimiter">/</span><span class="current">userRole</span></div>
<div class="cover ">
<h1 class="cover"><span>user</span><wbr></wbr><span><span>Role</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L201">source</a>)</span></span></div><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p><p class="paragraph">If you set it to <a href="-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return false.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/AkismetComment.kt#L180">source</a>)</span></span></div><p class="paragraph">The user role of the user who submitted the comment. This is an optional parameter.</p><p class="paragraph">If you set it to <a href="-companion/-a-d-m-i-n_-r-o-l-e.html">ADMIN_ROLE</a>, Akismet will always return <code class="lang-kotlin">false</code>.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/Akismet/#kotlin.String#kotlin.String/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/Akismet/#kotlin.String#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Akismet</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L226">source</a>)</span></span></div><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L58">source</a>)</span></span></div><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L219">source</a>)</span></span></div><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p><hr><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L55">source</a>)</span></span></div><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dateToGmt</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet.Companion/dateToGmt/#java.util.Date/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">dateToGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>date</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Gmt</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html">Date</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L74">source</a>)</span></span></div><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/date-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>dateGmt</span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/post-modified-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/LocalDateTime.html">LocalDateTime</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L87">source</a>)</span></span></div><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/date-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>dateGmt</span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/post-modified-gmt.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,43 +61,43 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><span class="current">Companion</span></div>
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet.Companion///PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><span class="current">Companion</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Companion</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L59">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L56">source</a>)</span></span></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1844418243%2FFunctions%2F769193423" anchor-label="dateToGmt" id="1844418243%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="table"><a data-name="1844418243%2FFunctions%2F-1617659094" anchor-label="dateToGmt" id="1844418243%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-to-gmt.html"><span>date</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1844418243%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1844418243%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html">LocalDateTime</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p></div><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html">Date</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/LocalDateTime.html">LocalDateTime</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a locale date/time to a UTC timestamp. (ISO 8601)</p></div><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="date-to-gmt.html"><span class="token function">dateToGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">date<span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html">Date</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Converts a date to a UTC timestamp. (ISO 8601)</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1924768251%2FFunctions%2F769193423" anchor-label="jsonComment" id="1924768251%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1924768251%2FFunctions%2F-1617659094" anchor-label="jsonComment" id="1924768251%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="json-comment.html"><span>json</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1924768251%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1924768251%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a></div><div class="brief "><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a></div><div class="brief "><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p></div></div></div>
</div>
</div>
</div>
@ -108,7 +108,7 @@
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet.Companion/jsonComment/#kotlin.String/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">jsonComment</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet.Companion/jsonComment/#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">Akismet</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">jsonComment</span></div>
<div class="cover ">
<h1 class="cover"><span>json</span><wbr></wbr><span><span>Comment</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L66">source</a>)</span></span></div><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/to-string.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>toString</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="json-comment.html"><span class="token function">jsonComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">json<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../-akismet-comment/index.html">AkismetComment</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L63">source</a>)</span></span></div><p class="paragraph">(Re)Creates a <a href="../../-akismet-comment/index.html">comment</a> from a JSON string.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet-comment/to-string.html"><span>Akismet</span><wbr></wbr><span>Comment.</span><wbr></wbr><span>toString</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/appUserAgent/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">appUserAgent</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/appUserAgent/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">appUserAgent</span></div>
<div class="cover ">
<h1 class="cover"><span>app</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Agent</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L125">source</a>)</span></span></div><p class="paragraph">The application user agent to be sent to Akismet.</p><p class="paragraph">If possible, the application user agent string should always use the following format:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea"> Application Name/Version</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">The library's own user agent string will automatically be appended.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#detailed-docs">Akismet API</a> for more details.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L122">source</a>)</span></span></div><p class="paragraph">The application user agent to be sent to Akismet.</p><p class="paragraph">If possible, the application user agent string should always use the following format:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea"> Application Name/Version</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">The library's own user agent string will automatically be appended.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#detailed-docs">Akismet API</a> for more details.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/blog/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">blog</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/blog/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">blog</span></div>
<div class="cover ">
<h1 class="cover"><span><span>blog</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L106">source</a>)</span></span></div><p class="paragraph">The URL registered with Akismet.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L103">source</a>)</span></span></div><p class="paragraph">The URL registered with Akismet.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/checkComment/#net.thauvin.erik.akismet.AkismetComment#kotlin.Boolean/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">checkComment</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/checkComment/#net.thauvin.erik.akismet.AkismetComment#kotlin.Boolean/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">checkComment</span></div>
<div class="cover ">
<h1 class="cover"><span>check</span><wbr></wbr><span><span>Comment</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L272">source</a>)</span></span></div><p class="paragraph">Comment Check.</p><p class="paragraph">This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data</p><p class="paragraph">By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return <code class="lang-kotlin">false</code> and log the error, use the <code class="lang-kotlin">trueOnError</code> parameter to change this behavior.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment is spam, <code class="lang-kotlin">false</code> if the comment is not.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error.</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword">fun </span><a href="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L265">source</a>)</span></span></div><p class="paragraph">Comment Check.</p><p class="paragraph">This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data</p><p class="paragraph">By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return <code class="lang-kotlin">false</code> and log the error, use the <code class="lang-kotlin">trueOnError</code> parameter to change this behavior.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment is spam, <code class="lang-kotlin">false</code> if the comment is not.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/debugHelp/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">debugHelp</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/debugHelp/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">debugHelp</span></div>
<div class="cover ">
<h1 class="cover"><span>debug</span><wbr></wbr><span><span>Help</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L198">source</a>)</span></span></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p><p class="paragraph">If the call returns neither <code class="lang-kotlin">true</code> nor <code class="lang-kotlin">false</code>, the <code class="lang-kotlin">x-akismet-debug-help</code> header will provide context for any error that has occurred.</p><p class="paragraph">Note that the <code class="lang-kotlin">x-akismet-debug-help</code> header will not always be sent if a response does not return <code class="lang-kotlin">false</code> or <code class="lang-kotlin">true</code>.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L191">source</a>)</span></span></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p><p class="paragraph">If the call returns neither <code class="lang-kotlin">true</code> nor <code class="lang-kotlin">false</code>, the <code class="lang-kotlin">x-akismet-debug-help</code> header will provide context for any error that has occurred.</p><p class="paragraph">Note that the <code class="lang-kotlin">x-akismet-debug-help</code> header will not always be sent if a response does not return <code class="lang-kotlin">false</code> or <code class="lang-kotlin">true</code>.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/errorMessage/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">errorMessage</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/errorMessage/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">errorMessage</span></div>
<div class="cover ">
<h1 class="cover"><span>error</span><wbr></wbr><span><span>Message</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L158">source</a>)</span></span></div><p class="paragraph">The error message.</p><p class="paragraph">The error (IO, empty response from Akismet, etc.) message is also logged as a warning.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="check-comment.html"><span>Akismet.</span><wbr></wbr><span>check</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L153">source</a>)</span></span></div><p class="paragraph">The error message.</p><p class="paragraph">The error (IO, empty response from Akismet, etc.) message is also logged as a warning.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="check-comment.html"><span>Akismet.</span><wbr></wbr><span>check</span><wbr></wbr><span><span>Comment</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/executeMethod/#okhttp3.HttpUrl#okhttp3.FormBody#kotlin.Boolean/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">executeMethod</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/executeMethod/#okhttp3.HttpUrl#okhttp3.FormBody#kotlin.Boolean/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">executeMethod</span></div>
<div class="cover ">
<h1 class="cover"><span>execute</span><wbr></wbr><span><span>Method</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L326">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>api</span><wbr></wbr><span><span>Url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>form</span><wbr></wbr><span><span>Body</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error (IO, empty response, etc.)</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L319">source</a>)</span></span></div><p class="paragraph">Executes a call to an Akismet REST API method.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>api</span><wbr></wbr><span><span>Url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>form</span><wbr></wbr><span><span>Body</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The HTTP POST form body containing the request parameters to be submitted.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>true</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Error</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Set to return <code class="lang-kotlin">true</code> on error (IO, empty response, etc.)</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/httpStatusCode/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">httpStatusCode</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/httpStatusCode/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">httpStatusCode</span></div>
<div class="cover ">
<h1 class="cover"><span>http</span><wbr></wbr><span>Status</span><wbr></wbr><span><span>Code</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L139">source</a>)</span></span></div><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L135">source</a>)</span></span></div><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,28 +61,28 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet///PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet///PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><span class="current">Akismet</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Akismet</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">Akismet</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L58">source</a>)</span></span></div><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">Akismet</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L55">source</a>)</span></span></div><p class="paragraph">Provides access to the <a href="https://akismet.com/development/api/">Akismet API</a>.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="708515701%2FConstructors%2F769193423" anchor-label="Akismet" id="708515701%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="table"><a data-name="708515701%2FConstructors%2F-1617659094" anchor-label="Akismet" id="708515701%2FConstructors%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-akismet.html"><span><span>Akismet</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="708515701%2FConstructors%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="708515701%2FConstructors%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">blog<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using an <a href="https://www.askimet.com/">Akismet</a> API key and URL registered with Akismet.</p></div><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Creates a new instance using the provided <a href="https://www.askimet.com/">Akismet</a> API key.</p></div></div></div>
</div>
</div>
</div>
@ -91,17 +91,17 @@
</div>
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-619578907%2FClasslikes%2F769193423" anchor-label="Companion" id="-619578907%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="table"><a data-name="-619578907%2FClasslikes%2F-1617659094" anchor-label="Companion" id="-619578907%2FClasslikes%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-619578907%2FClasslikes%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-619578907%2FClasslikes%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
</div>
</div>
</div>
@ -110,152 +110,152 @@
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="140563587%2FProperties%2F769193423" anchor-label="appUserAgent" id="140563587%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="table"><a data-name="140563587%2FProperties%2F-1617659094" anchor-label="appUserAgent" id="140563587%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="app-user-agent.html"><span>app</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Agent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="140563587%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="140563587%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The application user agent to be sent to Akismet.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="app-user-agent.html">appUserAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The application user agent to be sent to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1491328806%2FProperties%2F769193423" anchor-label="blog" id="-1491328806%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-1491328806%2FProperties%2F-1617659094" anchor-label="blog" id="-1491328806%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog.html"><span><span>blog</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1491328806%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1491328806%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The URL registered with Akismet.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog.html">blog</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The URL registered with Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1839698666%2FProperties%2F769193423" anchor-label="debugHelp" id="1839698666%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1839698666%2FProperties%2F-1617659094" anchor-label="debugHelp" id="1839698666%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="debug-help.html"><span>debug</span><wbr></wbr><span><span>Help</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1839698666%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1839698666%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="debug-help.html">debugHelp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-debug-help</code> header from the last operation, if any.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1854217411%2FProperties%2F769193423" anchor-label="errorMessage" id="-1854217411%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-1854217411%2FProperties%2F-1617659094" anchor-label="errorMessage" id="-1854217411%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="error-message.html"><span>error</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1854217411%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1854217411%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The error message.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="error-message.html">errorMessage</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The error message.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1217730997%2FProperties%2F769193423" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1217730997%2FProperties%2F-1617659094" anchor-label="httpStatusCode" id="1217730997%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="http-status-code.html"><span>http</span><wbr></wbr><span>Status</span><wbr></wbr><span><span>Code</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1217730997%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1217730997%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="http-status-code.html">httpStatusCode</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">The <a href="https://www.restapitutorial.com/httpstatuscodes.html">HTTP status code</a> of the last operation.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1920554762%2FProperties%2F769193423" anchor-label="isDiscard" id="1920554762%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1920554762%2FProperties%2F-1617659094" anchor-label="isDiscard" id="1920554762%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-discard.html"><span>is</span><wbr></wbr><span><span>Discard</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1920554762%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1920554762%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2050471377%2FProperties%2F769193423" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="2050471377%2FProperties%2F-1617659094" anchor-label="isVerifiedKey" id="2050471377%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-verified-key.html"><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2050471377%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2050471377%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1616027372%2FProperties%2F769193423" anchor-label="logger" id="1616027372%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1616027372%2FProperties%2F-1617659094" anchor-label="logger" id="1616027372%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="logger.html"><span><span>logger</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1616027372%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1616027372%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html">Logger</a></div><div class="brief "><p class="paragraph">The logger instance.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a></div><div class="brief "><p class="paragraph">The logger instance.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="42530702%2FProperties%2F769193423" anchor-label="proTip" id="42530702%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="42530702%2FProperties%2F-1617659094" anchor-label="proTip" id="42530702%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="pro-tip.html"><span>pro</span><wbr></wbr><span><span>Tip</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="42530702%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="42530702%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1549072997%2FProperties%2F769193423" anchor-label="response" id="-1549072997%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-1549072997%2FProperties%2F-1617659094" anchor-label="response" id="-1549072997%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="response.html"><span><span>response</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1549072997%2FProperties%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1549072997%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The actual response sent by Akismet from the last operation.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The actual response sent by Akismet from the last operation.</p></div></div></div>
</div>
</div>
</div>
@ -264,92 +264,92 @@
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="158460567%2FFunctions%2F769193423" anchor-label="checkComment" id="158460567%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="table"><a data-name="158460567%2FFunctions%2F-1617659094" anchor-label="checkComment" id="158460567%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="check-comment.html"><span>check</span><wbr></wbr><span><span>Comment</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="158460567%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="158460567%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Comment Check.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword">fun </span><a href="check-comment.html"><span class="token function">checkComment</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Comment Check.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1280463836%2FFunctions%2F769193423" anchor-label="executeMethod" id="1280463836%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="1280463836%2FFunctions%2F-1617659094" anchor-label="executeMethod" id="1280463836%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="execute-method.html"><span>execute</span><wbr></wbr><span><span>Method</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1280463836%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1280463836%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Executes a call to an Akismet REST API method.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html"><span class="token annotation builtin">JvmOverloads</span></a></div></div><span class="token keyword">fun </span><a href="execute-method.html"><span class="token function">executeMethod</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiUrl<span class="token operator">: </span><span data-unresolved-link="okhttp3/HttpUrl///PointingToDeclaration/">HttpUrl</span><span class="token punctuation">, </span></span><span class="parameter ">formBody<span class="token operator">: </span><span data-unresolved-link="okhttp3/FormBody///PointingToDeclaration/">FormBody</span><span class="token punctuation">, </span></span><span class="parameter ">trueOnError<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Executes a call to an Akismet REST API method.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-707138897%2FFunctions%2F769193423" anchor-label="reset" id="-707138897%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-707138897%2FFunctions%2F-1617659094" anchor-label="reset" id="-707138897%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="reset.html"><span><span>reset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-707138897%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-707138897%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1211675440%2FFunctions%2F769193423" anchor-label="submitHam" id="-1211675440%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-1211675440%2FFunctions%2F-1617659094" anchor-label="submitHam" id="-1211675440%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="submit-ham.html"><span>submit</span><wbr></wbr><span><span>Ham</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1211675440%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1211675440%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Submit Ham. (False Positives)</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Submit Ham. (False Positives)</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-578133801%2FFunctions%2F769193423" anchor-label="submitSpam" id="-578133801%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="-578133801%2FFunctions%2F-1617659094" anchor-label="submitSpam" id="-578133801%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="submit-spam.html"><span>submit</span><wbr></wbr><span><span>Spam</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-578133801%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-578133801%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Submit Spam. (Missed Spam)</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Submit Spam. (Missed Spam)</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="869122104%2FFunctions%2F769193423" anchor-label="verifyKey" id="869122104%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<a data-name="869122104%2FFunctions%2F-1617659094" anchor-label="verifyKey" id="869122104%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="verify-key.html"><span>verify</span><wbr></wbr><span><span>Key</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="869122104%2FFunctions%2F769193423"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="869122104%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Key Verification.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Key Verification.</p></div></div></div>
</div>
</div>
</div>
@ -360,7 +360,7 @@
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isDiscard/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isDiscard</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/isDiscard/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isDiscard</span></div>
<div class="cover ">
<h1 class="cover"><span>is</span><wbr></wbr><span><span>Discard</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L184">source</a>)</span></span></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="pro-tip.html"><span>Akismet.</span><wbr></wbr><span>proTip</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-discard.html">isDiscard</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L177">source</a>)</span></span></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if Akismet has determined that the last <a href="check-comment.html">checked comment</a> is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="pro-tip.html"><span>Akismet.</span><wbr></wbr><span>proTip</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/isVerifiedKey/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isVerifiedKey</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/isVerifiedKey/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">isVerifiedKey</span></div>
<div class="cover ">
<h1 class="cover"><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L132">source</a>)</span></span></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="verify-key.html"><span>Akismet.</span><wbr></wbr><span>verifyKey</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-verified-key.html">isVerifiedKey</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L129">source</a>)</span></span></div><p class="paragraph">Set to <code class="lang-kotlin">true</code> if the API Key has been verified.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="verify-key.html"><span>Akismet.</span><wbr></wbr><span>verifyKey</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/logger/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">logger</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/logger/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">logger</span></div>
<div class="cover ">
<h1 class="cover"><span><span>logger</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html">Logger</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L204">source</a>)</span></span></div><p class="paragraph">The logger instance.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L197">source</a>)</span></span></div><p class="paragraph">The logger instance.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/proTip/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">proTip</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/proTip/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">proTip</span></div>
<div class="cover ">
<h1 class="cover"><span>pro</span><wbr></wbr><span><span>Tip</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L172">source</a>)</span></span></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p><p class="paragraph">If the <code class="lang-kotlin">x-akismet-pro-tip</code> header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-discard.html"><span>Akismet.</span><wbr></wbr><span>isDiscard</span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="pro-tip.html">proTip</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L166">source</a>)</span></span></div><p class="paragraph">The <code class="lang-kotlin">x-akismet-pro-tip</code> header from the last operation, if any.</p><p class="paragraph">If the <code class="lang-kotlin">x-akismet-pro-tip</code> header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> for more details.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-discard.html"><span>Akismet.</span><wbr></wbr><span>isDiscard</span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/reset/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">reset</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/reset/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">reset</span></div>
<div class="cover ">
<h1 class="cover"><span><span>reset</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L372">source</a>)</span></span></div><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L365">source</a>)</span></span></div><p class="paragraph">Resets the <a href="debug-help.html">debugHelp</a>, <a href="error-message.html">errorMessage</a>, <a href="http-status-code.html">httpStatusCode</a>, <a href="is-discard.html">isDiscard</a>, <a href="is-verified-key.html">isVerifiedKey</a>, <a href="pro-tip.html">proTip</a>, and <a href="response.html">response</a> properties.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/response/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">response</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/response/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">response</span></div>
<div class="cover ">
<h1 class="cover"><span><span>response</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L148">source</a>)</span></span></div><p class="paragraph">The actual response sent by Akismet from the last operation.</p><p class="paragraph">For example: <code class="lang-kotlin">true</code>, <code class="lang-kotlin">false</code>, <code class="lang-kotlin">valid</code>, <code class="lang-kotlin">invalid</code>, etc.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="response.html">response</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L143">source</a>)</span></span></div><p class="paragraph">The actual response sent by Akismet from the last operation.</p><p class="paragraph">For example: <code class="lang-kotlin">true</code>, <code class="lang-kotlin">false</code>, <code class="lang-kotlin">valid</code>, <code class="lang-kotlin">invalid</code>, etc.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitHam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitHam</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/submitHam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitHam</span></div>
<div class="cover ">
<h1 class="cover"><span>submit</span><wbr></wbr><span><span>Ham</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L314">source</a>)</span></span></div><p class="paragraph">Submit Ham. (False Positives)</p><p class="paragraph">This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as <a href="check-comment.html">comment check</a> and <a href="submit-spam.html">submit spam</a>.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-ham">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="submit-ham.html"><span class="token function">submitHam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L307">source</a>)</span></span></div><p class="paragraph">Submit Ham. (False Positives)</p><p class="paragraph">This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as <a href="check-comment.html">comment check</a> and <a href="submit-spam.html">submit spam</a>.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-ham">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitSpam</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/submitSpam/#net.thauvin.erik.akismet.AkismetComment/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">submitSpam</span></div>
<div class="cover ">
<h1 class="cover"><span>submit</span><wbr></wbr><span><span>Spam</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L292">source</a>)</span></span></div><p class="paragraph">Submit Spam. (Missed Spam)</p><p class="paragraph">This call is for submitting comments that weren't marked as spam but should have been.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-spam">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="submit-spam.html"><span class="token function">submitSpam</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">comment<span class="token operator">: </span><a href="../-akismet-comment/index.html">AkismetComment</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L285">source</a>)</span></span></div><p class="paragraph">Submit Spam. (Missed Spam)</p><p class="paragraph">This call is for submitting comments that weren't marked as spam but should have been.</p><p class="paragraph">It is very important that the values you submit with this call match those of your <a href="check-comment.html">comment check</a> calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#submit-spam">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the comment was submitted, <code class="lang-kotlin">false</code> otherwise.</p></span></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -41,14 +41,14 @@
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
akismet-kotlin
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.0.0 </div>
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="akismet-kotlin::net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../../index.html">akismet-kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">verifyKey</span></div>
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/Akismet/verifyKey/#/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="index.html">Akismet</a><span class="delimiter">/</span><span class="current">verifyKey</span></div>
<div class="cover ">
<h1 class="cover"><span>verify</span><wbr></wbr><span><span>Key</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L246">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-verified-key.html"><span>Akismet.</span><wbr></wbr><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="verify-key.html"><span class="token function">verifyKey</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/Akismet.kt#L239">source</a>)</span></span></div><p class="paragraph">Key Verification.</p><p class="paragraph">Key verification authenticates your key before calling the <a href="check-comment.html">comment check</a>, <a href="submit-spam.html">submit spam</a>, or <a href="submit-ham.html">submit ham</a> methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.</p><p class="paragraph">See the <a href="https://akismet.com/development/api/#verify-key">Akismet API</a> for more details.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the key is valid, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="is-verified-key.html"><span>Akismet.</span><wbr></wbr><span>is</span><wbr></wbr><span>Verified</span><wbr></wbr><span><span>Key</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Builder</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/Builder/#kotlin.String#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</a><span class="delimiter">/</span><span class="current">Builder</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Builder</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L86">source</a>)</span></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

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

View file

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

View file

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

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>blogCharset</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/blogCharset/#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</a><span class="delimiter">/</span><span class="current">blogCharset</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Charset</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-charset.html"><span class="token function">blogCharset</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogCharset<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L189">source</a>)</span></span></div><p class="paragraph">Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p><hr><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L97">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>blogLang</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/blogLang/#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</a><span class="delimiter">/</span><span class="current">blogLang</span></div>
<div class="cover ">
<h1 class="cover"><span>blog</span><wbr></wbr><span><span>Lang</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-lang.html"><span class="token function">blogLang</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogLang<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L184">source</a>)</span></span></div><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p><p class="paragraph">A site with articles in English and French might use: <code class="lang-kotlin">en, fr_ca</code></p><hr><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L96">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

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

View file

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

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dateGmt</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/dateGmt/#kotlin.String/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</a><span class="delimiter">/</span><span class="current">dateGmt</span></div>
<div class="cover ">
<h1 class="cover"><span>date</span><wbr></wbr><span><span>Gmt</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-gmt.html"><span class="token function">dateGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dateGmt<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L170">source</a>)</span></span></div><p class="paragraph">Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.</p><p class="paragraph">May be omitted if the comment is sent to the API at the time it is created.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-akismet/-companion/date-to-gmt.html"><span>Akismet.</span><wbr></wbr><span>Companion.</span><wbr></wbr><span>dateToGmt</span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L94">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -0,0 +1,637 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Builder</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder///PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><span class="current">Builder</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Builder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Builder</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L86">source</a>)</span></span></div><p class="paragraph">Provides a configuration builder.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Ip</span></span></u></div></span></div><div><div class="title"><p class="paragraph">IP address of the comment submitter.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>user</span><wbr></wbr><span><span>Agent</span></span></u></div></span></div><div><div class="title"><p class="paragraph">User agent string of the web browser submitting the comment.</p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="198559308%2FConstructors%2F-1617659094" anchor-label="Builder" id="198559308%2FConstructors%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-builder.html"><span><span>Builder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="198559308%2FConstructors%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="1075125079%2FProperties%2F-1617659094" anchor-label="author" id="1075125079%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author.html"><span><span>author</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1075125079%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author.html">author</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1206396007%2FProperties%2F-1617659094" anchor-label="authorEmail" id="1206396007%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-email.html"><span>author</span><wbr></wbr><span><span>Email</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1206396007%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-email.html">authorEmail</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-133642380%2FProperties%2F-1617659094" anchor-label="authorUrl" id="-133642380%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-url.html"><span>author</span><wbr></wbr><span><span>Url</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-133642380%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="author-url.html">authorUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="794449934%2FProperties%2F-1617659094" anchor-label="blogCharset" id="794449934%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-charset.html"><span>blog</span><wbr></wbr><span><span>Charset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="794449934%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-charset.html">blogCharset</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1392873838%2FProperties%2F-1617659094" anchor-label="blogLang" id="-1392873838%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-lang.html"><span>blog</span><wbr></wbr><span><span>Lang</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1392873838%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="blog-lang.html">blogLang</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1391639359%2FProperties%2F-1617659094" anchor-label="content" id="1391639359%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content.html"><span><span>content</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1391639359%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="content.html">content</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-587875368%2FProperties%2F-1617659094" anchor-label="dateGmt" id="-587875368%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-gmt.html"><span>date</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-587875368%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="date-gmt.html">dateGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-762754778%2FProperties%2F-1617659094" anchor-label="isTest" id="-762754778%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-test.html"><span>is</span><wbr></wbr><span><span>Test</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-762754778%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-277139891%2FProperties%2F-1617659094" anchor-label="permalink" id="-277139891%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="permalink.html"><span><span>permalink</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-277139891%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="permalink.html">permalink</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1580800563%2FProperties%2F-1617659094" anchor-label="postModifiedGmt" id="1580800563%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="post-modified-gmt.html"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1580800563%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="post-modified-gmt.html">postModifiedGmt</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1127974369%2FProperties%2F-1617659094" anchor-label="recheckReason" id="-1127974369%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="recheck-reason.html"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1127974369%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="recheck-reason.html">recheckReason</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1138127363%2FProperties%2F-1617659094" anchor-label="referrer" id="1138127363%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="referrer.html"><span><span>referrer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1138127363%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="referrer.html">referrer</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1802692754%2FProperties%2F-1617659094" anchor-label="serverEnv" id="-1802692754%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="server-env.html"><span>server</span><wbr></wbr><span><span>Env</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1802692754%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="server-env.html">serverEnv</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="404819400%2FProperties%2F-1617659094" anchor-label="type" id="404819400%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="404819400%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="type.html">type</a><span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-365307362%2FProperties%2F-1617659094" anchor-label="userAgent" id="-365307362%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-agent.html"><span>user</span><wbr></wbr><span><span>Agent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-365307362%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="user-agent.html">userAgent</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1470901360%2FProperties%2F-1617659094" anchor-label="userIp" id="1470901360%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-ip.html"><span>user</span><wbr></wbr><span><span>Ip</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1470901360%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="user-ip.html">userIp</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1600411263%2FProperties%2F-1617659094" anchor-label="userRole" id="-1600411263%2FProperties%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-role.html"><span>user</span><wbr></wbr><span><span>Role</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1600411263%2FProperties%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">var </span><a href="user-role.html">userRole</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="130702093%2FFunctions%2F-1617659094" anchor-label="author" id="130702093%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author.html"><span><span>author</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="130702093%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author.html"><span class="token function">author</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">author<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the mame submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2026540029%2FFunctions%2F-1617659094" anchor-label="authorEmail" id="2026540029%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-email.html"><span>author</span><wbr></wbr><span><span>Email</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2026540029%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-email.html"><span class="token function">authorEmail</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorEmail<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the email address submitted with the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1404172784%2FFunctions%2F-1617659094" anchor-label="authorUrl" id="-1404172784%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="author-url.html"><span>author</span><wbr></wbr><span><span>Url</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1404172784%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="author-url.html"><span class="token function">authorUrl</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">authorUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the URL submitted with comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1097973686%2FFunctions%2F-1617659094" anchor-label="blogCharset" id="1097973686%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-charset.html"><span>blog</span><wbr></wbr><span><span>Charset</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1097973686%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-charset.html"><span class="token function">blogCharset</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogCharset<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1837195186%2FFunctions%2F-1617659094" anchor-label="blogLang" id="1837195186%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="blog-lang.html"><span>blog</span><wbr></wbr><span><span>Lang</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1837195186%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="blog-lang.html"><span class="token function">blogLang</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">blogLang<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2008846762%2FFunctions%2F-1617659094" anchor-label="build" id="2008846762%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="build.html"><span><span>build</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2008846762%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">CommentConfig</a></div><div class="brief "><p class="paragraph">Builds a new comment configuration.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1253714907%2FFunctions%2F-1617659094" anchor-label="content" id="-1253714907%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="content.html"><span><span>content</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1253714907%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="content.html"><span class="token function">content</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">content<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the content that was submitted.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-978299860%2FFunctions%2F-1617659094" anchor-label="dateGmt" id="-978299860%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="date-gmt.html"><span>date</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-978299860%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="date-gmt.html"><span class="token function">dateGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dateGmt<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1164757525%2FFunctions%2F-1617659094" anchor-label="isTest" id="-1164757525%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="is-test.html"><span>is</span><wbr></wbr><span><span>Test</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1164757525%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="is-test.html"><span class="token function">isTest</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">isTest<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">This is optional. You can set it when submitting test queries to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1317976105%2FFunctions%2F-1617659094" anchor-label="permalink" id="-1317976105%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="permalink.html"><span><span>permalink</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1317976105%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="permalink.html"><span class="token function">permalink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permalink<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the full permanent URL of the entry the comment was submitted to.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1663852977%2FFunctions%2F-1617659094" anchor-label="postModifiedGmt" id="1663852977%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="post-modified-gmt.html"><span>post</span><wbr></wbr><span>Modified</span><wbr></wbr><span><span>Gmt</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1663852977%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="post-modified-gmt.html"><span class="token function">postModifiedGmt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">postModifiedGmt<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-993443515%2FFunctions%2F-1617659094" anchor-label="recheckReason" id="-993443515%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="recheck-reason.html"><span>recheck</span><wbr></wbr><span><span>Reason</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-993443515%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="recheck-reason.html"><span class="token function">recheckReason</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">checkReason<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="677919713%2FFunctions%2F-1617659094" anchor-label="referrer" id="677919713%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="referrer.html"><span><span>referrer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="677919713%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="referrer.html"><span class="token function">referrer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">referrer<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the content of the referrer header.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-900595166%2FFunctions%2F-1617659094" anchor-label="serverEnv" id="-900595166%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="server-env.html"><span>server</span><wbr></wbr><span><span>Env</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-900595166%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="server-env.html"><span class="token function">serverEnv</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">serverEnv<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">In PHP, there is an array of environmental variables called <code class="lang-kotlin">$_SERVER</code> that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-679859672%2FFunctions%2F-1617659094" anchor-label="type" id="-679859672%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="type.html"><span><span>type</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-679859672%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="type.html"><span class="token function">type</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">type<span class="token operator">: </span><a href="../../-comment-type/index.html">CommentType</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets a string that describes the type of content being sent, such as:</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="657594278%2FFunctions%2F-1617659094" anchor-label="userAgent" id="657594278%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-agent.html"><span>user</span><wbr></wbr><span><span>Agent</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="657594278%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-agent.html"><span class="token function">userAgent</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userAgent<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the user agent string of the web browser submitting the comment.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="111123092%2FFunctions%2F-1617659094" anchor-label="userIp" id="111123092%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-ip.html"><span>user</span><wbr></wbr><span><span>Ip</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="111123092%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-ip.html"><span class="token function">userIp</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userIp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets the IP address of the comment submitter.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1161666851%2FFunctions%2F-1617659094" anchor-label="userRole" id="1161666851%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
<div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="user-role.html"><span>user</span><wbr></wbr><span><span>Role</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1161666851%2FFunctions%2F-1617659094"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="user-role.html"><span class="token function">userRole</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">userRole<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a></div><div class="brief "><p class="paragraph">Set the user role of the user who submitted the comment. This is an optional parameter.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>isTest</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../../index.html">
Akismet Kotlin
</a>
</div>
<div class="library-version">
1.1.0-SNAPSHOT </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="Akismet Kotlin::net.thauvin.erik.akismet/CommentConfig.Builder/isTest/#kotlin.Boolean/PointingToDeclaration//-1617659094">
<div class="breadcrumbs"><a href="../../../../index.html">Akismet Kotlin</a><span class="delimiter">/</span><a href="../../index.html">net.thauvin.erik.akismet</a><span class="delimiter">/</span><a href="../index.html">CommentConfig</a><span class="delimiter">/</span><a href="index.html">Builder</a><span class="delimiter">/</span><span class="current">isTest</span></div>
<div class="cover ">
<h1 class="cover"><span>is</span><wbr></wbr><span><span>Test</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="is-test.html"><span class="token function">isTest</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">isTest<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">CommentConfig.Builder</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L201">source</a>)</span></span></div><p class="paragraph">This is optional. You can set it when submitting test queries to Akismet.</p><hr><div class="symbol monospace"><span class="token keyword">var </span><a href="is-test.html">isTest</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/akismet-kotlin/tree/master/src/main/kotlin//net/thauvin/erik/akismet/CommentConfig.kt#L99">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>

View file

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

Some files were not shown because too many files have changed in this diff Show more