root/net.thauvin.erik.akismet/CommentConfig/Builder

Builder

data class Builder(var userIp: String, var userAgent: String)

Provides a configuration builder.

Parameters

userIp

IP address of the comment submitter.

userAgent

User agent string of the web browser submitting the comment.

Constructors

constructor(userIp: String, userAgent: String)

Properties

var author: String

var authorEmail: String

var authorUrl: String

var blogCharset: String

var blogLang: String

var content: String

var dateGmt: String

var isTest: Boolean

var permalink: String

postModifiedGmt

var postModifiedGmt: String

var recheckReason: String

var referrer: String

var serverEnv: Map<String, String>

var type: CommentType

var userAgent: String

var userIp: String

var userRole: String

Functions

fun author(author: String): CommentConfig.Builder

Sets the mame submitted with the comment.

fun authorEmail(authorEmail: String): CommentConfig.Builder

Sets the email address submitted with the comment.

fun authorUrl(authorUrl: String): CommentConfig.Builder

Sets the URL submitted with comment.

fun blogCharset(blogCharset: String): CommentConfig.Builder

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

fun blogLang(blogLang: String): CommentConfig.Builder

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

fun build(): CommentConfig

Builds a new comment configuration.

fun content(content: String): CommentConfig.Builder

Sets the content that was submitted.

fun dateGmt(dateGmt: String): CommentConfig.Builder

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

fun isTest(isTest: Boolean): CommentConfig.Builder

This is optional. You can set it when submitting test queries to Akismet.

fun permalink(permalink: String): CommentConfig.Builder

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

postModifiedGmt

fun postModifiedGmt(postModifiedGmt: String): CommentConfig.Builder

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

fun recheckReason(checkReason: String): CommentConfig.Builder

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.

fun referrer(referrer: String): CommentConfig.Builder

Sets the content of the referrer header.

fun serverEnv(serverEnv: Map<String, String>): CommentConfig.Builder

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.

fun type(type: CommentType): CommentConfig.Builder

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

fun userAgent(userAgent: String): CommentConfig.Builder

Sets the user agent string of the web browser submitting the comment.

fun userIp(userIp: String): CommentConfig.Builder

Sets the IP address of the comment submitter.

fun userRole(userRole: String): CommentConfig.Builder

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