erik/akismet-kotlin
erik/akismet-kotlin
1
1
Fork 0
Code Issues Pull requests Releases Activity

Updated javadoc.

Browse source
This commit is contained in:
Erik C. Thauvin 2019-09-19 12:12:01 -07:00
parent 56aa74bd26
commit beb752c672
1 changed files with 45 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

67
src/main/kotlin/net/thauvin/erik/akismet/Akismet.kt
View file

@ -43,7 +43,14 @@ import java.util.logging.Logger
import javax.servlet.http.HttpServletRequest import javax.servlet.http.HttpServletRequest
/** /**
* Akismet Kotlin/Java Client Library * A small Kotlin/Java library for accessing the Akismet service.
*
* @constructor Creates a new instance.
*
* @param apiKey The [Akismet](https://www.askimet.com/) API key.
* @param blog The URL registered with Akismet.
*
* @author [Erik C. Thauvin](https://erik.thauvin.net/)
*/ */
@Version(properties = "version.properties", type = "kt") @Version(properties = "version.properties", type = "kt")
open class Akismet(apiKey: String, blog: String) { open class Akismet(apiKey: String, blog: String) {
@ -75,17 +82,38 @@ open class Akismet(apiKey: String, blog: String) {
private var client: OkHttpClient private var client: OkHttpClient
var isValidKey: Boolean = false var isValidKey: Boolean = false
/**
* Check if the API Key has been verified.
*/
var isVerifiedKey: Boolean = false
private set private set
/**
* The HTTP status code of the last operation.
*/
private set
/**
* The X-akismet-pro-tip header from the last operation, if any.
*/
@Suppress("MemberVisibilityCanBePrivate") @Suppress("MemberVisibilityCanBePrivate")
var proTip: String = "" var proTip: String = ""
private set private set
/**
* The X-akismet-error header from the last operation, if any.
*/
@Suppress("MemberVisibilityCanBePrivate") @Suppress("MemberVisibilityCanBePrivate")
var error: String = "" var error: String = ""
private set private set
/**
* The X-akismet-debug-help header from the last operation, if any.
*/
@Suppress("MemberVisibilityCanBePrivate") @Suppress("MemberVisibilityCanBePrivate")
var degugHelp: String = "" var degugHelp: String = ""
private set private set
/**
* The logger instance.
*/
val logger: Logger by lazy { Logger.getLogger(Akismet::class.java.simpleName) } val logger: Logger by lazy { Logger.getLogger(Akismet::class.java.simpleName) }
init { init {
@ -109,9 +137,8 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Key Verification * Key Verification.
* * See the [Akismet API](https://akismet.com/development/api/#verify-key) for more details.
* @see <a href="https://akismet.com/development/api/#verify-key">Akismet API</a>
*/ */
fun verifyKey(): Boolean { fun verifyKey(): Boolean {
val params = HashMap<String, String>() val params = HashMap<String, String>()
@ -122,9 +149,9 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Comment Check using [HttpServletRequest][request] content. * Comment Check using the content of a
* * [HttpServletRequest](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html).
* @see <a href="https://akismet.com/development/api/#comment-check">Akismet API</a> * See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
*/ */
@JvmOverloads @JvmOverloads
fun checkComment( fun checkComment(
@ -165,9 +192,7 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Comment Check * Comment Check. See the [Akismet API](https://akismet.com/development/api/#comment-check) for more details.
*
* @see <a href="https://akismet.com/development/api/#comment-check">Akismet API</a>
*/ */
@JvmOverloads @JvmOverloads
fun checkComment( fun checkComment(
@ -215,9 +240,9 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Submit Spam * Submit Spam (missed spam) using the content of a
* * [HttpServletRequest](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html).
* @see <a href="https://akismet.com/development/api/#submit-spam">Akismet API</a> * See the [Akismet API](https://akismet.com/development/api/#submit-spam) for more details.
*/ */
@JvmOverloads @JvmOverloads
fun submitSpam( fun submitSpam(
@ -258,9 +283,8 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Submit Spam (missed spam) * Submit Spam (missed spam).
* * See the [Akismet API](https://akismet.com/development/api/#submit-spam) for more details.
* @see <a href="https://akismet.com/development/api/#submit-spam">Akismet API</a>
*/ */
@JvmOverloads @JvmOverloads
fun submitSpam( fun submitSpam(
@ -305,9 +329,9 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Submit Ham (false positives) * Submit Ham (false positives) using the content of a
* * [HttpServletRequest](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html).
* @see <a href="https://akismet.com/development/api/#submit-ham">Akismet API</a> * See the [Akismet API](https://akismet.com/development/api/#submit-ham) for more details.
*/ */
@JvmOverloads @JvmOverloads
fun submitHam( fun submitHam(
@ -348,9 +372,8 @@ open class Akismet(apiKey: String, blog: String) {
} }
/** /**
* Submit Ham * Submit Ham.
* * See the [Akismet API](https://akismet.com/development/api/#submit-ham) for more details.
* @see <a href="https://akismet.com/development/api/#submit-ham">Akismet API</a>
*/ */
@JvmOverloads @JvmOverloads
fun submitHam( fun submitHam(