Rss Node.js Reference Documentation

Rss

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.2

Represents an RSS document or sub-part of a document such as a channel, image, or item. The RSS API allows one to download, create and modify RSS documents.

Object Creation

var obj = new chilkat.Rss();

Properties

DebugLogFilePath

DebugLogFilePath

· string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

LastErrorHtml

· string, read-only

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText

· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml

· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess

· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumChannels

NumChannels

· integer, read-only

The number of channels in the RSS document.

NumItems

NumItems

· integer, read-only

The number of items in the channel.

VerboseLogging

VerboseLogging

· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version

· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddNewChannel

var ret_rss = AddNewChannel();

· Returns a Rss

Adds a new channel to the RSS document. Returns the Rss object representing the Channel which can then be edited.

Returns null on failure

AddNewImage

var ret_rss = AddNewImage();

· Returns a Rss

Adds a new image to the RSS document. Returns the Rss object representing the image, which can then be edited.

Returns null on failure

AddNewItem

var ret_rss = AddNewItem();

· Returns a Rss

Adds a new Item to an Rss channel. Returns the Rss object representing the item which can then be edited.

Returns null on failure

DownloadRss

var status = DownloadRss(url);

· Returns Boolean (true for success, false for failure).
· url String

Downloads an RSS document from the Internet and populates the Rss object with the contents.

Returns true for success, false for failure.

More Information and Examples

Example: Read RSS Feed

DownloadRssAsync ⁽¹⁾

var ret_task = DownloadRssAsync(url);

· Returns a Task
· url String

Creates an asynchronous task to call the DownloadRss method with the arguments provided.

Returns null on failure

GetAttr

var retStr = GetAttr(tag, attrName);

· Returns a String.
· tag String
· attrName String

Returns the value of a sub-element attribute. For example, to get the value of the "isPermaLink" attribute of the "guid" sub-element, call item.GetAttr("guid","isPermaLink").

Returns null on failure

GetChannel

var ret_rss = GetChannel(index);

· Returns a Rss
· index Number

Returns the Nth channel of an RSS document. Usually there is only 1 channel per document, so the index argument should be set to 0.

Returns null on failure

GetCount

var retInt = GetCount(tag);

· Returns a Number.
· tag String

Return the number of sub-elements with a specific tag.

GetDateStr

var retStr = GetDateStr(tag);

· Returns a String.
· tag String

The same as GetDate, except the date/time is returned in RFC822 string format.

Returns null on failure

GetImage

var ret_rss = GetImage();

· Returns a Rss

Return the image associated with the channel.

Returns null on failure

GetInt

var retInt = GetInt(tag);

· Returns a Number.
· tag String

Return the value of a numeric sub-element as an integer.

GetItem

var ret_rss = GetItem(index);

· Returns a Rss
· index Number

Return the Nth item of a channel as an RSS object.

Returns null on failure

GetString

var retStr = GetString(tag);

· Returns a String.
· tag String

Return the value of an sub-element as a string.

Returns null on failure

LoadRssFile

var status = LoadRssFile(filePath);

· Returns Boolean (true for success, false for failure).
· filePath String

Load an RSS document from a file.

Returns true for success, false for failure.

LoadRssString

var status = LoadRssString(rssString);

· Returns Boolean (true for success, false for failure).
· rssString String

Loads an RSS feed document from an in-memory string.

Returns true for success, false for failure.

LoadTaskCaller

var status = LoadTaskCaller(task);

· Returns Boolean (true for success, false for failure).
· task Task

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

MGetAttr

var retStr = MGetAttr(tag, index, attrName);

· Returns a String.
· tag String
· index Number
· attrName String

Get an attribute value for the Nth sub-element having a specific tag. As an example, an RSS item may have several "category" sub-elements. To get the value of the "domain" attribute for the 3rd category, call MGetAttr("category",2,"domain").

Returns null on failure

MGetString

var retStr = MGetString(tag, index);

· Returns a String.
· tag String
· index Number

Get the value of the Nth occurrence of a sub-element. Indexing begins at 0.

Returns null on failure

MSetAttr

var status = MSetAttr(tag, idx, attrName, value);

· Returns Boolean (true for success, false for failure).
· tag String
· idx Number
· attrName String
· value String

Set an attribute on the Nth occurrence of a sub-element.

Returns true for success, false for failure.

MSetString

var status = MSetString(tag, idx, value);

· Returns Boolean (true for success, false for failure).
· tag String
· idx Number
· value String

Set the value of the Nth occurrence of a sub-element. Indexing begins at 0.

Returns true for success, false for failure.

NewRss

NewRss();

· Does not return anything (returns Undefined).

Clears the RSS document.

Remove

Remove(tag);

· Does not return anything (returns Undefined).
· tag String

Removes a sub-element from the RSS document.

SetAttr

SetAttr(tag, attrName, value);

· Does not return anything (returns Undefined).
· tag String
· attrName String
· value String

Sets the value of a sub-element attribute.

SetDateNow

SetDateNow(tag);

· Does not return anything (returns Undefined).
· tag String

Sets the value of a date/time sub-element to the current system date/time.

SetDateStr

SetDateStr(tag, dateTimeStr);

· Does not return anything (returns Undefined).
· tag String
· dateTimeStr String

The same as SetDate, except the date/time is passed as an RFC822 string.

SetInt

SetInt(tag, value);

· Does not return anything (returns Undefined).
· tag String
· value Number

Sets the value of an integer sub-element.

SetString

SetString(tag, value);

· Does not return anything (returns Undefined).
· tag String
· value String

Sets the value of a sub-element.

ToXmlString

var retStr = ToXmlString();

· Returns a String.

Returns the RSS document as an XML string.

Returns null on failure