Class TrackbackMessage

Represents a Trackback ping request that can be sent using the TrackbackClient class.

Inheritance

System.Object

TrackbackMessage

Implements

System.IComparable

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Argotic.Net

Assembly: Argotic.Core.dll

Syntax

[Serializable]
public class TrackbackMessage : IComparable

Examples

Constructors

| Improve this Doc View Source

TrackbackMessage()

Initializes a new instance of the TrackbackMessage class.

Declaration

public TrackbackMessage()

| Improve this Doc View Source

TrackbackMessage(Uri)

Initializes a new instance of the TrackbackMessage class using the supplied System.Uri.

Declaration

public TrackbackMessage(Uri permalink)

Parameters

Type	Name	Description
System.Uri	permalink	A System.Uri that represents the permalink for the entry.

Remarks

The permalink should point as closely as possible to the actual entry on the HTML page, as it will be used when linking to the entry in question.

Exceptions

Type	Condition
System.ArgumentNullException	The `value` is a null reference (Nothing in Visual Basic).

Properties

| Improve this Doc View Source

Encoding

Gets or sets the Encoding of this message.

Declaration

public Encoding Encoding { get; set; }

Property Value

Type	Description
System.Text.Encoding	A Encoding that specifies the character encoding of this message. The default value is System.Text.UTF8Encoding.

Exceptions

Type	Condition
System.ArgumentNullException	The `value` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

Excerpt

Gets or sets an excerpt for the entry.

Declaration

public string Excerpt { get; set; }

Property Value

Type	Description
System.String	An excerpt of the entry.

Remarks

The excerpt must be in the character encoding specified by the Encoding property.

| Improve this Doc View Source

Permalink

Gets or sets the permalink for the entry.

Declaration

public Uri Permalink { get; set; }

Property Value

Type	Description
System.Uri	A System.Uri that represents the permalink for the entry.

Remarks

The permalink should point as closely as possible to the actual entry on the HTML page, as it will be used when linking to the entry in question.

Exceptions

Type	Condition
System.ArgumentNullException	The `value` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

Title

Gets or sets the title of the entry.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The title of the entry.

Remarks

The title must be in the character encoding specified by the Encoding property.

| Improve this Doc View Source

WeblogName

Gets or sets the name of the weblog to which the entry was posted.

Declaration

public string WeblogName { get; set; }

Property Value

Type	Description
System.String	The name of the weblog to which the entry was posted.

Remarks

The blog name must be in the character encoding specified by the Encoding property.

Methods

| Improve this Doc View Source

CompareTo(Object)

Compares the current instance with another object of the same type.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare with this instance.

Returns

Type	Description
System.Int32	A 32-bit signed integer that indicates the relative order of the objects being compared.

Exceptions

Type	Condition
System.ArgumentException	The `obj` is not the expected System.Type.

| Improve this Doc View Source

Equals(Object)

Determines whether the specified System.Object is equal to the current instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with the current instance.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to the current instance; otherwise, false.

Overrides

System.Object.Equals(System.Object)

| Improve this Doc View Source

GetHashCode()

Returns a hash code for the current instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A 32-bit signed integer hash code.

Overrides

System.Object.GetHashCode()

| Improve this Doc View Source

Load(NameValueCollection)

Loads this TrackbackMessage using the supplied System.Collections.Specialized.NameValueCollection.

Declaration

public bool Load(NameValueCollection source)

Parameters

Type	Name	Description
System.Collections.Specialized.NameValueCollection	source	The System.Collections.Specialized.NameValueCollection to extract information from.

Returns

Type	Description
System.Boolean	true if the TrackbackMessage was initialized using the supplied `source`, otherwise false.

Remarks

This method expects the supplied source to be the HTTP Request Parameters or a similar subset.

Exceptions

Type	Condition
System.ArgumentNullException	The `source` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

ToString()

Returns a System.String that represents the current TrackbackMessage.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current TrackbackMessage.

Overrides

System.Object.ToString()

Remarks

This method returns the URL-encoded representation for the current instance.

| Improve this Doc View Source

WriteTo(StreamWriter)

Saves the current TrackbackMessage to the specified System.IO.StreamWriter.

Declaration

public void WriteTo(StreamWriter writer)

Parameters

Type	Name	Description
System.IO.StreamWriter	writer	The System.IO.StreamWriter to which you want to save.

Exceptions

Type	Condition
System.ArgumentNullException	The `writer` is a null reference (Nothing in Visual Basic).

Operators

| Improve this Doc View Source

Equality(TrackbackMessage, TrackbackMessage)

Determines if operands are equal.

Declaration

public static bool operator ==(TrackbackMessage first, TrackbackMessage second)

Parameters

Type	Name	Description
TrackbackMessage	first	Operand to be compared.
TrackbackMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the values of its operands are equal, otherwise; false.

| Improve this Doc View Source

GreaterThan(TrackbackMessage, TrackbackMessage)

Determines if first operand is greater than second operand.

Declaration

public static bool operator>(TrackbackMessage first, TrackbackMessage second)

Parameters

Type	Name	Description
TrackbackMessage	first	Operand to be compared.
TrackbackMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is greater than the second, otherwise; false.

| Improve this Doc View Source

Inequality(TrackbackMessage, TrackbackMessage)

Determines if operands are not equal.

Declaration

public static bool operator !=(TrackbackMessage first, TrackbackMessage second)

Parameters

Type	Name	Description
TrackbackMessage	first	Operand to be compared.
TrackbackMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	false if its operands are equal, otherwise; true.

| Improve this Doc View Source

LessThan(TrackbackMessage, TrackbackMessage)

Determines if first operand is less than second operand.

Declaration

public static bool operator <(TrackbackMessage first, TrackbackMessage second)

Parameters

Type	Name	Description
TrackbackMessage	first	Operand to be compared.
TrackbackMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is less than the second, otherwise; false.

Implements

System.IComparable