Class DiscoverableSyndicationEndpoint

Represents a discoverable syndication endpoint that is being broadcast by a web resource.

Inheritance

System.Object

DiscoverableSyndicationEndpoint

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.Common

Assembly: Argotic.Common.dll

Syntax

[Serializable]
public class DiscoverableSyndicationEndpoint : IComparable

Constructors

| Improve this Doc View Source

DiscoverableSyndicationEndpoint()

Initializes a new instance of the DiscoverableSyndicationEndpoint class.

Declaration

public DiscoverableSyndicationEndpoint()

| Improve this Doc View Source

DiscoverableSyndicationEndpoint(Uri, String)

Initializes a new instance of the DiscoverableSyndicationEndpoint class using the supplied System.Uri and MIME content type.

Declaration

public DiscoverableSyndicationEndpoint(Uri source, string contentType)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the Uniform Resource Locator (URL) of the syndication endpoint.
System.String	contentType	The MIME content type that the syndicated resource conforms to.

Exceptions

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

| Improve this Doc View Source

DiscoverableSyndicationEndpoint(Uri, String, String)

Initializes a new instance of the DiscoverableSyndicationEndpoint class using the supplied System.Uri, MIME content type and title.

Declaration

public DiscoverableSyndicationEndpoint(Uri source, string contentType, string title)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the Uniform Resource Locator (URL) of the syndication endpoint.
System.String	contentType	The MIME content type that the syndicated resource conforms to.
System.String	title	The title of the syndication endpoint.

Exceptions

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

Properties

| Improve this Doc View Source

ContentFormat

Gets the SyndicationContentFormat of the syndication endpoint.

Declaration

public SyndicationContentFormat ContentFormat { get; }

Property Value

Type	Description
SyndicationContentFormat	A SyndicationContentFormat enumeration value that indicates the syndication content format that the auto-discoverable syndicated content conforms to. If a format cannot be determined for the ContentType, returns None.

Remarks

The syndication content format is determined based upon the ContentType of the current instance.

| Improve this Doc View Source

ContentType

Gets or sets the MIME content type of the syndication endpoint.

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
System.String	The registered MIME type of the syndication endpoint.

Remarks

See http://www.iana.org/assignments/media-types/ for a listing of registered MIME types.

Exceptions

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

| Improve this Doc View Source

Source

Gets or sets the Uniform Resource Locator (URL) of the syndication endpoint.

Declaration

public Uri Source { get; set; }

Property Value

Type	Description
System.Uri	The System.Uri of the syndication endpoint.

Remarks

The System.Urican be either Relative or Absolute. It is up to the caller to resolve the endpoint source as appropriate.

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 syndication endpoint.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The title of the syndication endpoint.

Remarks

This property will be empty if no title attribute was assigned to the syndication endpoint link.

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

CreateNavigator()

Initializes a read-only System.Xml.XPath.XPathNavigator object for navigating through the auto-discoverable syndicated content located at the Source.

Declaration

public XPathNavigator CreateNavigator()

Returns

Type	Description
System.Xml.XPath.XPathNavigator	A read-only System.Xml.XPath.XPathNavigator object for navigating the auto-discoverable syndicated content.

Exceptions

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

| 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

ToString()

Returns a System.String that represents the current DiscoverableSyndicationEndpoint.

Declaration

public override string ToString()

Returns

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

Overrides

System.Object.ToString()

Remarks

This method returns the XHTML representation for the current instance.

Operators

| Improve this Doc View Source

Equality(DiscoverableSyndicationEndpoint, DiscoverableSyndicationEndpoint)

Determines if operands are equal.

Declaration

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

Parameters

Type	Name	Description
DiscoverableSyndicationEndpoint	first	Operand to be compared.
DiscoverableSyndicationEndpoint	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(DiscoverableSyndicationEndpoint, DiscoverableSyndicationEndpoint)

Determines if first operand is greater than second operand.

Declaration

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

Parameters

Type	Name	Description
DiscoverableSyndicationEndpoint	first	Operand to be compared.
DiscoverableSyndicationEndpoint	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(DiscoverableSyndicationEndpoint, DiscoverableSyndicationEndpoint)

Determines if operands are not equal.

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

LessThan(DiscoverableSyndicationEndpoint, DiscoverableSyndicationEndpoint)

Determines if first operand is less than second operand.

Declaration

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

Parameters

Type	Name	Description
DiscoverableSyndicationEndpoint	first	Operand to be compared.
DiscoverableSyndicationEndpoint	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