Belin.Akismet

5.0.0

src/Cmdlets/Test-Comment.psm1

using namespace Belin.Akismet

<#
.SYNOPSIS
    Checks the specified comment against the service database, and returns a value indicating whether it is spam.
.INPUTS
    The comment to be submitted.
.OUTPUTS
    A value indicating whether the specified comment is spam.
#>
function Test-Comment {
    [CmdletBinding()]
    [OutputType([Belin.Akismet.CheckResult])]
    param (
        # The comment to be submitted.
        [Parameter(Mandatory, Position = 0, ValueFromPipeline)]
        [Comment] $Comment,

        # The Akismet client used to submit the comment.
        [Parameter(Mandatory)]
        [Client] $Client
    )

    process {
        $Client.CheckComment($Comment)
    }
}