Atom Node.js Reference Documentation

Atom

Current Version: 9.5.0.97

Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.

Object Creation

var obj = new chilkat.Atom();

Properties

AbortCurrent
AbortCurrent
· boolean, read-only
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
DebugLogFilePath
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.

top
LastErrorHtml
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.

top
LastErrorText
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.

top
LastErrorXml
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.

top
LastMethodSuccess
LastMethodSuccess
· boolean

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
NumEntries
NumEntries
· integer, read-only

Number of entries in the Atom document.

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

top
Version
Version
· string, read-only

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

More Information and Examples
top

Methods

AddElement
var retInt = AddElement(tag, value);
· Returns a Number.
· tag String
· value String

Adds a new element to the Atom document. The tag is a string such as "title", "subtitle", "summary", etc. Returns the index of the element added, or -1 for failure.

top
AddElementDateStr
var retInt = AddElementDateStr(tag, dateTimeStr);
· Returns a Number.
· tag String
· dateTimeStr String

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. The dateTimeStr should be an RFC822 formatted date/time string such as "Tue, 25 Sep 2012 12:25:32 -0500". Returns the index of the element added, or -1 for failure.

top
AddElementDt
var retInt = AddElementDt(tag, dateTime);
· Returns a Number.
· tag String
· dateTime CkDateTime

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

top
AddElementHtml
var retInt = AddElementHtml(tag, htmlStr);
· Returns a Number.
· tag String
· htmlStr String

Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddElementXHtml
var retInt = AddElementXHtml(tag, xmlStr);
· Returns a Number.
· tag String
· xmlStr String

Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddElementXml
var retInt = AddElementXml(tag, xmlStr);
· Returns a Number.
· tag String
· xmlStr String

Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

top
AddEntry
AddEntry(xmlStr);
· Does not return anything (returns Undefined).
· xmlStr String

Adds an "entry" Atom XML document to the caller's Atom document.

top
AddLink
AddLink(rel, href, title, typ);
· Does not return anything (returns Undefined).
· rel String
· href String
· title String
· typ String

Adds a link to the Atom document.

top
AddPerson
AddPerson(tag, name, uri, email);
· Does not return anything (returns Undefined).
· tag String
· name String
· uri String
· email String

Adds a person to the Atom document. The tag should be a string such as "author", "contributor", etc. If a piece of information is not known, an empty string or NULL value may be passed.

top
DeleteElement
DeleteElement(tag, index);
· Does not return anything (returns Undefined).
· tag String
· index Number

Removes the Nth occurrence of a given element from the Atom document. Indexing begins at 0. For example, to remove the 2nd category, set tag = "category" and index = 1.

top
DeleteElementAttr
DeleteElementAttr(tag, index, attrName);
· Does not return anything (returns Undefined).
· tag String
· index Number
· attrName String

Remove an attribute from an element.The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index ( 0 = first occurrence ).

top
DeletePerson
DeletePerson(tag, index);
· Does not return anything (returns Undefined).
· tag String
· index Number

Deletes a person from the Atom document. The tag is a string such as "author". The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index. For example, DeletePerson("author",2) deletes the 3rd author.

top
DownloadAtom
var status = DownloadAtom(url);
· Returns Boolean (true for success, false for failure).
· url String

Download an Atom feed from the Internet and load it into the Atom object.

Returns true for success, false for failure.

top
DownloadAtomAsync (1)
var ret_task = DownloadAtomAsync(url);
· Returns a Task
· url String

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

Returns null on failure

top
GetElement
var retStr = GetElement(tag, index);
· Returns a String.
· tag String
· index Number

Returns the content of the Nth element having a specified tag.

Returns null on failure

top
GetElementAttr
var retStr = GetElementAttr(tag, index, attrName);
· Returns a String.
· tag String
· index Number
· attrName String

Returns the value of an element's attribute. The element is selected by the tag name and the index (the Nth element having a specific tag) and the attribute is selected by name.

Returns null on failure

top
GetElementCount
var retInt = GetElementCount(tag);
· Returns a Number.
· tag String

The number of elements having a specific tag.

top
GetElementDateStr
var retStr = GetElementDateStr(tag, index);
· Returns a String.
· tag String
· index Number

Returns an element's value as a date/time in an RFC822 formatted string, such as such as "Tue, 25 Sep 2012 12:25:32 -0500".

Returns null on failure

top
GetElementDt
var ret_ckDateTime = GetElementDt(tag, index);
· Returns a CkDateTime
· tag String
· index Number

Returns an element's value as a date/time object.

Returns null on failure

top
GetEntry
var ret_atom = GetEntry(index);
· Returns a Atom
· index Number

Returns the Nth entry as an Atom object. (Indexing begins at 0)

Returns null on failure

top
GetLinkHref
var retStr = GetLinkHref(relName);
· Returns a String.
· relName String

Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).

Returns null on failure

top
GetPersonInfo
var retStr = GetPersonInfo(tag, index, tag2);
· Returns a String.
· tag String
· index Number
· tag2 String

Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").

Returns null on failure

top
GetTopAttr
var retStr = GetTopAttr(attrName);
· Returns a String.
· attrName String

Returns the value of an attribute on the top-level XML node. The tag of a top-level Atom XML node is typically "feed" or "entry", and it might have attributes such as "xmlns" and "xml:lang".

Returns null on failure

top
HasElement
var retBool = HasElement(tag);
· Returns a Boolean.
· tag String

True (1) if the element exists in the Atom document. Otherwise 0.

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

top
LoadXml
var status = LoadXml(xmlStr);
· Returns Boolean (true for success, false for failure).
· xmlStr String

Loads the Atom document from an XML string.

Returns true for success, false for failure.

top
NewEntry
NewEntry();
· Does not return anything (returns Undefined).

Initializes the Atom document to be a new "entry".

top
NewFeed
NewFeed();
· Does not return anything (returns Undefined).

Initializes the Atom document to be a new "feed".

top
SetElementAttr
SetElementAttr(tag, index, attrName, attrValue);
· Does not return anything (returns Undefined).
· tag String
· index Number
· attrName String
· attrValue String

Adds or replaces an attribute on an element.

top
SetTopAttr
SetTopAttr(attrName, value);
· Does not return anything (returns Undefined).
· attrName String
· value String

Adds or replaces an attribute on the top-level XML node of the Atom document.

top
ToXmlString
var retStr = ToXmlString();
· Returns a String.

Serializes the Atom document to an XML string.

Returns null on failure

top
UpdateElement
UpdateElement(tag, index, value);
· Does not return anything (returns Undefined).
· tag String
· index Number
· value String

Replaces the content of an element.

top
UpdateElementDateStr
UpdateElementDateStr(tag, index, dateTimeStr);
· Does not return anything (returns Undefined).
· tag String
· index Number
· dateTimeStr String

Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.

top
UpdateElementDt
UpdateElementDt(tag, index, dateTime);
· Does not return anything (returns Undefined).
· tag String
· index Number
· dateTime CkDateTime

Replaces the content of a date-formatted element.

top
UpdateElementHtml
UpdateElementHtml(tag, index, htmlStr);
· Does not return anything (returns Undefined).
· tag String
· index Number
· htmlStr String

Replaces the content of an HTML element.

top
UpdateElementXHtml
UpdateElementXHtml(tag, index, xmlStr);
· Does not return anything (returns Undefined).
· tag String
· index Number
· xmlStr String

Replaces the content of an XHTML element.

top
UpdateElementXml
UpdateElementXml(tag, index, xmlStr);
· Does not return anything (returns Undefined).
· tag String
· index Number
· xmlStr String

Replaces the content of an XML element.

top
UpdatePerson
UpdatePerson(tag, index, name, uri, email);
· Does not return anything (returns Undefined).
· tag String
· index Number
· name String
· uri String
· email String

Replaces the content of a person. To update the 3rd author, call UpdatePerson("author",2,"new name","new URL","new email"). If a piece of information is not known, pass an empty string or a NULL.

top