akismet-kotlin/net.thauvin.erik.akismet/AkismetComment

AkismetComment

open class AkismetComment(val userIp: String, val userAgent: String)

A comment to send to Akismet.

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.

See the Akismet API for more details.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

Constructors

AkismetComment

fun AkismetComment(request: HttpServletRequest)

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

AkismetComment

fun AkismetComment(userIp: String, userAgent: String)

Creates a new instance.

Types

Companion

object Companion

Functions

equals

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

Indicates whether some other object is equal to this one.

hashCode

open override fun hashCode(): Int

Returns a hash code value for the object.

toJson

fun toJson(): String

Returns a JSON representation of the comment.

toString

open override fun toString(): String

Returns a JSON representation of the comment.

Properties

author

var author: String?

Name submitted with the comment.

authorEmail

var authorEmail: String?

Email address submitted with the comment.

authorUrl

var authorUrl: String?

URL submitted with comment.

blogCharset

var blogCharset: String?

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

blogLang

var blogLang: String?

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

content

var content: String?

The content that was submitted.

dateGmt

var dateGmt: String?

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

isTest

var isTest: Boolean = false

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

permalink

var permalink: String?

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

postModifiedGmt

var postModifiedGmt: String?

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

recheckReason

var recheckReason: String?

If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.

referrer

var referrer: String?

The content of the referer header should be set here.

serverEnv

var serverEnv: Map<String, String>

In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.

type

var type: String?

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

userAgent

val userAgent: String

userIp

val userIp: String

userRole

var userRole: String?

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

Sources

jvm source