Akismet

open class Akismet(apiKey: String)

Provides access to the Akismet API.

Constructors

Akismet

fun Akismet(apiKey: String, blog: String)

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

Akismet

fun Akismet(apiKey: String)

Creates a new instance using the provided Akismet API key.

Types

Companion

object Companion

Functions

checkComment

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

Comment Check.

executeMethod

fun executeMethod(apiUrl: HttpUrl?, formBody: FormBody, trueOnError: Boolean = false): Boolean

Executes a call to an Akismet REST API method.

reset

fun reset()

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

submitHam

fun submitHam(comment: AkismetComment): Boolean

Submit Ham. (False Positives)

submitSpam

fun submitSpam(comment: AkismetComment): Boolean

Submit Spam. (Missed Spam)

verifyKey

fun verifyKey(): Boolean

Key Verification.

Properties

appUserAgent

var appUserAgent: String

The application user agent to be sent to Akismet.

blog

var blog: String

The URL registered with Akismet.

debugHelp

var debugHelp: String

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

errorMessage

var errorMessage: String

The error message.

httpStatusCode

var httpStatusCode: Int = 0

The HTTP status code of the last operation.

isDiscard

var isDiscard: Boolean = false

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

isVerifiedKey

var isVerifiedKey: Boolean = false

Set to true if the API Key has been verified.

logger

val logger: Logger

The logger instance.

proTip

var proTip: String

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

response

var response: String

The actual response sent by Akismet from the last operation.

Sources

jvm source