Atom Lianja Reference Documentation
Atom
Current Version: 10.0.0
Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.
Object Creation
loObject = createobject("CkAtom")
Properties
AbortCurrent
When set to .T., 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 .F. when the next method is called. When the abort occurs, this property is reset to .F.. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)
topDebugLogFilePath
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
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.
topLastErrorText
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
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.
topLastMethodSuccess
Indicate whether the last method call succeeded or failed. A value of .T. indicates success, a value of .F. 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 = .T. and failure = .F..
- 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 .T.. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumEntries
Number of entries in the Atom document.
topVerboseLogging
If set to .T., then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is .F.. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
AddElement
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.
topAddElementDateStr
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.
topAddElementDt
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.
topAddElementHtml
Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddElementXHtml
Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddElementXml
Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddEntry
Adds an "entry" Atom XML document to the caller's Atom document.
topAddLink
Adds a link to the Atom document.
topAddPerson
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.
topDeleteElement
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.
topDeleteElementAttr
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 ).
topDeletePerson
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.
topDownloadAtom
Download an Atom feed from the Internet and load it into the Atom object.
Returns .T. for success, .F. for failure.
topDownloadAtomAsync (1)
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 .F. on failure
topGetElement
GetElementAttr
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 .F. on failure
topGetElementCount
The number of elements having a specific tag.
topGetElementDateStr
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 .F. on failure
topGetElementDt
GetEntry
GetLinkHref
Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).
Returns .F. on failure
topGetPersonInfo
Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").
Returns .F. on failure
topGetTopAttr
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 .F. on failure
topHasElement
True (1) if the element exists in the Atom document. Otherwise 0.
topLoadTaskCaller
LoadXml
NewEntry
Initializes the Atom document to be a new "entry".
topNewFeed
Initializes the Atom document to be a new "feed".
topSetElementAttr
Adds or replaces an attribute on an element.
topSetTopAttr
Adds or replaces an attribute on the top-level XML node of the Atom document.
topToXmlString
UpdateElement
Replaces the content of an element.
topUpdateElementDateStr
Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.
topUpdateElementDt
Replaces the content of a date-formatted element.
topUpdateElementHtml
Replaces the content of an HTML element.
topUpdateElementXHtml
Replaces the content of an XHTML element.
topUpdateElementXml
Replaces the content of an XML element.
topUpdatePerson
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