IComment.cs :  » Bloggers » SubText » Subtext » Akismet » C# / CSharp Open Source

#region Disclaimer/Info

///////////////////////////////////////////////////////////////////////////////////////////////////
// Subtext WebLog
// 
// Subtext is an open source weblog system that is a fork of the .TEXT
// weblog system.
//
// For updated news and information please visit http://subtextproject.com/
// Subtext is hosted at Google Code at http://code.google.com/p/subtext/
// The development mailing list is at subtext@googlegroups.com 
//
// This project is licensed under the BSD license.  See the License.txt file for more information.
///////////////////////////////////////////////////////////////////////////////////////////////////

#endregion

using System;
using System.Collections.Specialized;
using System.Diagnostics.CodeAnalysis;
using System.Net;

namespace Subtext.Akismet{
    /// <summary>
    /// Defines the base information about a comment submitted to 
    /// Akismet.
    /// </summary>
    public interface IComment
    {
        /// <summary>
        /// The name submitted with the comment.
        /// </summary>
        string Author { get; }

        /// <summary>
        /// The email submitted with the comment.
        /// </summary>
        string AuthorEmail { get; }

        /// <summary>
        /// The url submitted if provided.
        /// </summary>
        Uri AuthorUrl { get; }

        /// <summary>
        /// Content of the comment
        /// </summary>
        string Content { get; }

        /// <summary>
        /// The HTTP_REFERER header value of the 
        /// originating comment.
        /// </summary>
        string Referrer { get; }

        /// <summary>
        /// Permanent location of the entry the comment was 
        /// submitted to.
        /// </summary>
        [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Permalink")]
        Uri Permalink { get; }

        /// <summary>
        /// User agent of the requester. (Required)
        /// </summary>
        string UserAgent { get; }

        /// <summary>
        /// May be one of the following: {blank}, "comment", "trackback", "pingback", or a made-up value 
        /// like "registration".
        /// </summary>
        string CommentType { get; }

        /// <summary>
        /// IPAddress of the submitter
        /// </summary>
        IPAddress IPAddress { get; }

        /// <summary>
        /// Optional collection of various server environment variables. 
        /// </summary>
        NameValueCollection ServerEnvironmentVariables { get; }
    }
}