Rss Node.js Reference Documentation

Rss

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

· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

LastErrorHtml

· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorXml

· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

· boolean
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

NumChannels

· integer, read-only

The number of channels in the RSS document.

NumItems

· integer, read-only

The number of items in the channel.

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

· string, read-only

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

Methods

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.

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.

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.

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.

Example: Read RSS Feed

var ret_task = DownloadRssAsync(url);

· Returns a Task
· url String

Creates an asynchronous task to call the DownloadRss method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run a Node.js Asynchronous Task

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 true for success, false for failure.

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.

var retInt = GetCount(tag);

· Returns a Number.
· tag String

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

var retStr = GetDateStr(tag);

· Returns a String.
· tag String

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

Returns true for success, false for failure.

var ret_rss = GetImage();

· Returns a Rss

Return the image associated with the channel.

var retInt = GetInt(tag);

· Returns a Number.
· tag String

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

var ret_rss = GetItem(index);

· Returns a Rss
· index Number

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

var retStr = GetString(tag);

· Returns a String.
· tag String

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

Returns true for success, false for failure.

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.

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.

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 true for success, false for failure.

var retStr = MGetString(tag, index);

· Returns a String.
· tag String
· index Number

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

Returns true for success, false for failure.

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 occurance of a sub-element.

Returns true for success, false for failure.

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 occurance of a sub-element. Indexing begins at 0.

Returns true for success, false for failure.

NewRss();

· Does not return anything (returns Undefined).

Clears the RSS document.

Remove(tag);

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

Removes a sub-element from the RSS document.

var status = SaveLastError(path);

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

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

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(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(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(tag, value);

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

Sets the value of an integer sub-element.

SetString(tag, value);

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

Sets the value of a sub-element.

var retStr = ToXmlString();

· Returns a String.

Returns the RSS document as an XML string.

Returns true for success, false for failure.