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

Akismet

open class Akismet(apiKey: String)

Provides access to the Akismet API.

Constructors

fun Akismet(apiKey: String, blog: String)

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

fun Akismet(apiKey: String)

Creates a new instance using the provided Akismet API key.

Types

object Companion

Functions

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

Comment Check.

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

Executes a call to an Akismet REST API method.

fun reset()

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

fun submitHam(comment: AkismetComment): Boolean

Submit Ham. (False Positives)

fun submitSpam(comment: AkismetComment): Boolean

Submit Spam. (Missed Spam)

fun verifyKey(): Boolean

Key Verification.

Properties

var appUserAgent: String

The application user agent to be sent to Akismet.

var blog: String

The URL registered with Akismet.

var debugHelp: String

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

var errorMessage: String

The error message.

var httpStatusCode: Int = 0

The HTTP status code of the last operation.

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.

var isVerifiedKey: Boolean = false

Set to true if the API Key has been verified.

val logger: Logger

The logger instance.

var proTip: String

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

var response: String

The actual response sent by Akismet from the last operation.

Sources