C# Class Subtext.Akismet.AkismetClient

Show file Open project: ayende/Subtext Class Usage Examples

Public Methods

Method Description
AkismetClient ( string apiKey, Uri blogUrl ) : System

Initializes a new instance of the AkismetClient class.

AkismetClient ( string apiKey, Uri blogUrl, HttpClient httpClient ) : System

Initializes a new instance of the AkismetClient class.

This constructor takes in all the dependencies to allow for dependency injection and unit testing. Seems like overkill, but it's worth it.

BuildUserAgent ( string applicationName, string appVersion ) : string

Helper method for building a user agent string in the format preferred by Akismet.

CheckCommentForSpam ( IComment comment ) : bool

Checks the comment and returns true if it is spam, otherwise false.

SubmitHam ( IComment comment ) : void

Submits a comment to Akismet that should not have been flagged as SPAM (a false positive).

SubmitSpam ( IComment comment ) : void

Submits a comment to Akismet that should have been flagged as SPAM, but was not flagged by Akismet.

VerifyApiKey ( ) : bool

Verifies the API key. You really only need to call this once, perhaps at startup.

Private Methods

Method Description
SetServiceUrls ( ) : void
SubmitComment ( IComment comment, Uri url ) : string

Method Details

AkismetClient() public method

Initializes a new instance of the AkismetClient class.
public AkismetClient ( string apiKey, Uri blogUrl ) : System
apiKey string The Akismet API key.
blogUrl System.Uri The root url of the blog.
return System

AkismetClient() public method

Initializes a new instance of the AkismetClient class.
This constructor takes in all the dependencies to allow for dependency injection and unit testing. Seems like overkill, but it's worth it.
public AkismetClient ( string apiKey, Uri blogUrl, HttpClient httpClient ) : System
apiKey string The Akismet API key.
blogUrl System.Uri The root url of the blog.
httpClient HttpClient Client class used to make the underlying requests.
return System

BuildUserAgent() public static method

Helper method for building a user agent string in the format preferred by Akismet.
public static BuildUserAgent ( string applicationName, string appVersion ) : string
applicationName string Name of the application.
appVersion string The version of the app.
return string

CheckCommentForSpam() public method

Checks the comment and returns true if it is spam, otherwise false.
public CheckCommentForSpam ( IComment comment ) : bool
comment IComment
return bool

SubmitHam() public method

Submits a comment to Akismet that should not have been flagged as SPAM (a false positive).
public SubmitHam ( IComment comment ) : void
comment IComment
return void

SubmitSpam() public method

Submits a comment to Akismet that should have been flagged as SPAM, but was not flagged by Akismet.
public SubmitSpam ( IComment comment ) : void
comment IComment
return void

VerifyApiKey() public method

Verifies the API key. You really only need to call this once, perhaps at startup.
If it cannot make a request of Akismet.
public VerifyApiKey ( ) : bool
return bool