CkRss Java Reference Documentation

CkRss

Current Version: 9.5.0.75

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

CkRss obj = new CkRss();

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

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.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

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.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

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.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

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.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);
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.

top
NumChannels
int get_NumChannels();

The number of channels in the RSS document.

top
NumItems
int get_NumItems();

The number of items in the channel.

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

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.

top
Version
void get_Version(CkString str);
String version();

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

top

Methods

AddNewChannel
CkRss AddNewChannel();

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

Returns nil on failure

top
AddNewImage
CkRss AddNewImage();

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

Returns nil on failure

top
AddNewItem
CkRss AddNewItem();

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

Returns nil on failure

top
DownloadRss
boolean DownloadRss(String url);

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

Returns true for success, false for failure.

top
DownloadRssAsync (Android™) (Java)
CkTask DownloadRssAsync(String url);

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
GetAttr
boolean GetAttr(String tag, String attrName, CkString outStr);
String getAttr(String tag, String attrName);

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.

top
GetChannel
CkRss GetChannel(int index);

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 nil on failure

top
GetCount
int GetCount(String tag);

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

top
GetDateStr
boolean GetDateStr(String tag, CkString outStr);
String getDateStr(String tag);

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

Returns true for success, false for failure.

top
GetImage
CkRss GetImage();

Return the image associated with the channel.

Returns nil on failure

top
GetInt
int GetInt(String tag);

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

top
GetItem
CkRss GetItem(int index);

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

Returns nil on failure

top
GetString
boolean GetString(String tag, CkString outStr);
String getString(String tag);

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

Returns true for success, false for failure.

top
LoadRssFile
boolean LoadRssFile(String filePath);

Load an RSS document from a file.

Returns true for success, false for failure.

top
LoadRssString
boolean LoadRssString(String rssString);

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

Returns true for success, false for failure.

top
MGetAttr
boolean MGetAttr(String tag, int index, String attrName, CkString outStr);
String mGetAttr(String tag, int index, String attrName);

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.

top
MGetString
boolean MGetString(String tag, int index, CkString outStr);
String mGetString(String tag, int index);

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

Returns true for success, false for failure.

top
MSetAttr
boolean MSetAttr(String tag, int idx, String attrName, String value);

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

Returns true for success, false for failure.

top
MSetString
boolean MSetString(String tag, int idx, String value);

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

Returns true for success, false for failure.

top
NewRss
void NewRss();

Clears the RSS document.

top
Remove
void Remove(String tag);

Removes a sub-element from the RSS document.

top
SaveLastError
boolean SaveLastError(String path);

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

Returns true for success, false for failure.

top
SetAttr
void SetAttr(String tag, String attrName, String value);

Sets the value of a sub-element attribute.

top
SetDateNow
void SetDateNow(String tag);

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

top
SetDateStr
void SetDateStr(String tag, String dateTimeStr);

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

top
SetInt
void SetInt(String tag, int value);

Sets the value of an integer sub-element.

top
SetString
void SetString(String tag, String value);

Sets the value of a sub-element.

top
ToXmlString
boolean ToXmlString(CkString outStr);
String toXmlString();

Returns the RSS document as an XML string.

Returns true for success, false for failure.

top

Events

Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

// Install an event callback handler to get progress events.
MyBaseProgress rssProgress = new MyBaseProgress();
http.put_EventCallbackObject(rssProgress);

MyBaseProgress example:

import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;

public class MyBaseProgress extends CkBaseProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
}
AbortCheck
public boolean AbortCheck();

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return true to abort; return false to continue (not abort)

top
PercentDone
public boolean PercentDone(int pctDone);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return true to abort; return false to continue (not abort)

top
ProgressInfo
public void ProgressInfo(String name, String value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

top
TaskCompleted
public void TaskCompleted(CkTask task);

Called in the background thread when an asynchronous task completes.

top