Interface ISyndicationResource

Allows an object to implement a syndication resource by representing a set of properties, methods, indexers and events common to web content syndication resources.

Namespace: Argotic.Common

Assembly: Argotic.Common.dll

Syntax

public interface ISyndicationResource

Examples

Properties

Format

Gets the SyndicationContentFormat that the resource implements.

Declaration

SyndicationContentFormat Format { get; }

Property Value

Type	Description
SyndicationContentFormat	The SyndicationContentFormat enumeration value that indicates the type of syndication format that the resource implements.

Version

Gets the Version of the SyndicationContentFormat that the resource conforms to.

Declaration

Version Version { get; }

Property Value

Type	Description
System.Version	The Version of the SyndicationContentFormat that the resource conforms to.

Methods

CreateNavigator()

Initializes a read-only System.Xml.XPath.XPathNavigator object for navigating through nodes in this ISyndicationResource.

Declaration

XPathNavigator CreateNavigator()

Returns

Type	Description
System.Xml.XPath.XPathNavigator	A read-only System.Xml.XPath.XPathNavigator object.

Remarks

The System.Xml.XPath.XPathNavigator is positioned on the root element of the ISyndicationResource. If there is no root element, the System.Xml.XPath.XPathNavigator is positioned on the first element in the XML representation of the ISyndicationResource.

Load(Stream)

Loads the syndication resource from the specified System.IO.Stream.

Declaration

void Load(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The Stream used to load the syndication resource.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.IO.Stream.

Notes to Implementers:

• When implementing this method, the stream should be passed to the Load(Stream, SyndicationResourceLoadSettings) method with the settings parameter as null.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).
System.FormatException	The stream data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(Stream, SyndicationResourceLoadSettings)

Loads the syndication resource from the specified System.IO.Stream and SyndicationResourceLoadSettings.

Declaration

void Load(Stream stream, SyndicationResourceLoadSettings settings)

Parameters

Type	Name	Description
System.IO.Stream	stream	The Stream used to load the syndication resource.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.IO.Stream.

Notes to Implementers:

• When implementing this method, the stream should be used to create a System.Xml.XPath.XPathNavigator that is then passed to the Load(IXPathNavigable) method.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).
System.FormatException	The stream data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(Uri, WebRequestOptions)

Loads the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Declaration

void Load(Uri source, WebRequestOptions options)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that points to the location of the web resource used to load the syndication resource.
WebRequestOptions	options	A WebRequestOptions that holds options that should be applied to web requests.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(Uri, WebRequestOptions, SyndicationResourceLoadSettings)

Loads the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials, System.Net.IWebProxy and SyndicationResourceLoadSettings.

Declaration

void Load(Uri source, WebRequestOptions options, SyndicationResourceLoadSettings settings)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that points to the location of the web resource used to load the syndication resource.
WebRequestOptions	options	A WebRequestOptions that holds options that should be applied to web requests.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(Uri, ICredentials, IWebProxy)

Loads the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Declaration

void Load(Uri source, ICredentials credentials, IWebProxy proxy)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that points to the location of the web resource used to load the syndication resource.
System.Net.ICredentials	credentials	A System.Net.ICredentials that provides the proper set of credentials to the source resource when required. This value can be null.
System.Net.IWebProxy	proxy	A System.Net.IWebProxy that provides proxy access to the source resource when required. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Notes to Implementers:

• When implementing this method, the source, credentials, and proxy parameters should be passed to the Load(Uri, ICredentials, IWebProxy, SyndicationResourceLoadSettings) method with the settings parameter as null.
• If credentials is null, request should be made using the default application credentials.
• If proxy is null, request should be made using the System.Net.WebRequest default proxy settings.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(Uri, ICredentials, IWebProxy, SyndicationResourceLoadSettings)

Loads the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials, System.Net.IWebProxy and SyndicationResourceLoadSettings.

Declaration

void Load(Uri source, ICredentials credentials, IWebProxy proxy, SyndicationResourceLoadSettings settings)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that points to the location of the web resource used to load the syndication resource.
System.Net.ICredentials	credentials	A System.Net.ICredentials that provides the proper set of credentials to the source resource when required. This value can be null.
System.Net.IWebProxy	proxy	A System.Net.IWebProxy that provides proxy access to the source resource when required. This value can be null.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the supplied System.Uri using the specified System.Net.ICredentials and System.Net.IWebProxy.

Notes to Implementers:

• If credentials is null, request should be made using the default application credentials.
• If proxy is null, request should be made using the System.Net.WebRequest default proxy settings.
• Implementers should consider using the CreateSafeNavigator(Uri, ICredentials, IWebProxy, Encoding) utility method to retrieve the syndication resource information in a safe manner.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(XmlReader)

Loads the syndication resource from the specified System.Xml.XmlReader.

Declaration

void Load(XmlReader reader)

Parameters

Type	Name	Description
System.Xml.XmlReader	reader	The XmlReader used to load the syndication resource.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.Xml.XmlReader.

Notes to Implementers:

• When implementing this method, the reader should be passed to the Load(XmlReader, SyndicationResourceLoadSettings) method with the settings parameter as null.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The reader is a null reference (Nothing in Visual Basic).
System.FormatException	The reader data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(XmlReader, SyndicationResourceLoadSettings)

Loads the syndication resource from the specified System.Xml.XmlReader and SyndicationResourceLoadSettings.

Declaration

void Load(XmlReader reader, SyndicationResourceLoadSettings settings)

Parameters

Type	Name	Description
System.Xml.XmlReader	reader	The XmlReader used to load the syndication resource.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.Xml.XmlReader.

Notes to Implementers:

• When implementing this method, the reader should be used to create a System.Xml.XPath.XPathNavigator that is then passed to the Load(IXPathNavigable) method.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The reader is a null reference (Nothing in Visual Basic).
System.FormatException	The reader data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(IXPathNavigable)

Loads the syndication resource from the specified System.Xml.XPath.IXPathNavigable.

Declaration

void Load(IXPathNavigable source)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	source	The IXPathNavigable used to load the syndication resource.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.Xml.XPath.IXPathNavigable.

Notes to Implementers:

• When implementing this method, the source should be passed to the Load(IXPathNavigable, SyndicationResourceLoadSettings) method with the settings parameter as null.
• After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

Load(IXPathNavigable, SyndicationResourceLoadSettings)

Loads the syndication resource from the specified System.Xml.XPath.IXPathNavigable and SyndicationResourceLoadSettings.

Declaration

void Load(IXPathNavigable source, SyndicationResourceLoadSettings settings)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	source	The IXPathNavigable used to load the syndication resource.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Load abstract method to load the syndication resource from the specified System.Xml.XPath.IXPathNavigable.

Notes to Implementers: After the load operation has successfully completed, the Loaded event must be raised.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the resource remains empty.
System.Xml.XmlException	There is a load or parse error in the XML. In this case, the resource remains empty.

LoadAsync(Uri, SyndicationResourceLoadSettings, WebRequestOptions, Object)

Loads the syndication resource asynchronously using the specified System.Uri, SyndicationResourceLoadSettings, System.Net.ICredentials, and System.Net.IWebProxy.

Declaration

void LoadAsync(Uri source, SyndicationResourceLoadSettings settings, WebRequestOptions options, object userToken)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the URL of the syndication resource XML data.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.
WebRequestOptions	options	A WebRequestOptions that holds options that should be applied to web requests.
System.Object	userToken	A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Remarks

Place your custom code in the LoadAsync abstract method to load the syndication resource asynchronously from the specified System.Uri, SyndicationResourceLoadSettings, System.Net.ICredentials and System.Net.IWebProxy.

To receive notification when the operation has completed or the operation has been canceled, add an event handler to the Loaded event. You can cancel a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) operation by calling the LoadAsyncCancel() method.

After calling LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object), you must wait for the load operation to complete before attempting to load the syndication resource using the LoadAsync(Uri, Object) method.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the feed remains empty.
System.InvalidOperationException	This ISyndicationResource has a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) call in progress.

LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object)

Loads the syndication resource asynchronously using the specified System.Uri, SyndicationResourceLoadSettings, System.Net.ICredentials, and System.Net.IWebProxy.

Declaration

void LoadAsync(Uri source, SyndicationResourceLoadSettings settings, ICredentials credentials, IWebProxy proxy, object userToken)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the URL of the syndication resource XML data.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.
System.Net.ICredentials	credentials	A System.Net.ICredentials that provides the proper set of credentials to the source when required. This value can be null.
System.Net.IWebProxy	proxy	A System.Net.IWebProxy that provides proxy access to the source when required. This value can be null.
System.Object	userToken	A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Remarks

Place your custom code in the LoadAsync abstract method to load the syndication resource asynchronously from the specified System.Uri, SyndicationResourceLoadSettings, System.Net.ICredentials and System.Net.IWebProxy.

To receive notification when the operation has completed or the operation has been canceled, add an event handler to the Loaded event. You can cancel a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) operation by calling the LoadAsyncCancel() method.

After calling LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object), you must wait for the load operation to complete before attempting to load the syndication resource using the LoadAsync(Uri, Object) method.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the feed remains empty.
System.InvalidOperationException	This ISyndicationResource has a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) call in progress.

LoadAsync(Uri, SyndicationResourceLoadSettings, Object)

Loads the syndication resource asynchronously using the specified System.Uri and SyndicationResourceLoadSettings.

Declaration

void LoadAsync(Uri source, SyndicationResourceLoadSettings settings, object userToken)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the URL of the syndication resource XML data.
SyndicationResourceLoadSettings	settings	The SyndicationResourceLoadSettings object used to configure the ISyndicationResource instance. This value can be null.
System.Object	userToken	A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Remarks

Place your custom code in the LoadAsync abstract method to load the syndication resource asynchronously from the specified System.Uri and SyndicationResourceLoadSettings.

To receive notification when the operation has completed or the operation has been canceled, add an event handler to the Loaded event. You can cancel a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) operation by calling the LoadAsyncCancel() method.

After calling LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object), you must wait for the load operation to complete before attempting to load the syndication resource using the LoadAsync(Uri, SyndicationResourceLoadSettings, Object) method.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the feed remains empty.
System.InvalidOperationException	This ISyndicationResource has a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) call in progress.

LoadAsync(Uri, Object)

Loads the syndication resource asynchronously using the specified System.Uri.

Declaration

void LoadAsync(Uri source, object userToken)

Parameters

Type	Name	Description
System.Uri	source	A System.Uri that represents the URL of the syndication resource XML data.
System.Object	userToken	A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Remarks

Place your custom code in the LoadAsync abstract method to load the syndication resource asynchronously from the specified System.Uri.

The ISyndicationResource should be loaded using the default SyndicationResourceLoadSettings.

To receive notification when the operation has completed or the operation has been canceled, add an event handler to the Loaded event. You can cancel a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) operation by calling the LoadAsyncCancel() method.

After calling LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object), you must wait for the load operation to complete before attempting to load the syndication resource using the LoadAsync(Uri, Object) method.

Exceptions

Type	Condition
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).
System.FormatException	The source data does not conform to the expected syndication content format. In this case, the feed remains empty.
System.InvalidOperationException	This ISyndicationResource has a LoadAsync(Uri, SyndicationResourceLoadSettings, ICredentials, IWebProxy, Object) call in progress.

LoadAsyncCancel()

Cancels an asynchronous operation to load the syndication resource.

Declaration

void LoadAsyncCancel()

Remarks

Use the LoadAsyncCancel method to cancel a pending LoadAsync(Uri, Object) operation. If there is a load operation in progress, this method releases resources used to execute the load operation. If there is no load operation pending, this method does nothing.

Save(Stream)

Saves the syndication resource to the specified System.IO.Stream.

Declaration

void Save(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The Stream to which you want to save the syndication resource.

Remarks

Place your custom code in the Save virtual method to save the syndication resource to the specified System.IO.Stream.

Notes to Implementers: When implementing this method, the stream should be passed to the Save(Stream, SyndicationResourceSaveSettings) method with the settings parameter as null.

Exceptions

Type	Condition
System.ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).
System.Xml.XmlException	The operation would not result in well formed XML for the syndication resource.

Save(Stream, SyndicationResourceSaveSettings)

Saves the syndication resource to the specified System.IO.Stream.

Declaration

void Save(Stream stream, SyndicationResourceSaveSettings settings)

Parameters

Type	Name	Description
System.IO.Stream	stream	The Stream to which you want to save the syndication resource.
SyndicationResourceSaveSettings	settings	The SyndicationResourceSaveSettings object used to configure the persistance of the ISyndicationResource instance. This value can be null.

Remarks

Place your custom code in the Save virtual method to save the syndication resource to the specified System.IO.Stream.

Notes to Implementers: When implementing this method, the stream should be used to create a System.Xml.XmlWriter that is then passed to the Save(XmlWriter) method.

Exceptions

Type	Condition
System.ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).
System.Xml.XmlException	The operation would not result in well formed XML for the syndication resource.

Save(XmlWriter)

Saves the syndication resource to the specified System.Xml.XmlWriter.

Declaration

void Save(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The XmlWriter to which you want to save the syndication resource.

Remarks

Place your custom code in the Save virtual method to save the syndication resource to the specified System.Xml.XmlWriter.

Notes to Implementers: When implementing this method, a default instance the SyndicationResourceSaveSettings should be created and then passed to the Save(XmlWriter, SyndicationResourceSaveSettings) method along with the supplied writer.

Exceptions

Type	Condition
System.ArgumentNullException	The writer is a null reference (Nothing in Visual Basic).
System.Xml.XmlException	The operation would not result in well formed XML for the syndication resource.

Save(XmlWriter, SyndicationResourceSaveSettings)

Saves the syndication resource to the specified System.Xml.XmlWriter.

Declaration

void Save(XmlWriter writer, SyndicationResourceSaveSettings settings)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The XmlWriter to which you want to save the syndication resource.
SyndicationResourceSaveSettings	settings	The SyndicationResourceSaveSettings object used to configure the persistance of the ISyndicationResource instance.

Remarks

Place your custom code in the Save virtual method to save the syndication resource to the specified System.Xml.XmlWriter using the SyndicationResourceSaveSettings.

Exceptions

Type	Condition
System.ArgumentNullException	The writer is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The settings is a null reference (Nothing in Visual Basic).
System.Xml.XmlException	The operation would not result in well formed XML for the syndication resource.

Events

Loaded

Occurs when the syndication resource state has been changed by a load operation.

Declaration

event EventHandler<SyndicationResourceLoadedEventArgs> Loaded

Event Type

Type	Description
System.EventHandler<SyndicationResourceLoadedEventArgs>

See Also

Load(IXPathNavigable)

Load(XmlReader)

See Also

SyndicationResourceMetadata