Atom CkPython Reference Documentation
CkAtom
Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.
Object Creation
obj = chilkat.CkAtom()
Properties
AbortCurrent
boolVal = atom.get_AbortCurrent();
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.)
topDebugLogFilePath
# ckStr is a CkString
atom.get_DebugLogFilePath(ckStr);
strVal = atom.debugLogFilePath();
atom.put_DebugLogFilePath(strVal);
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.
LastErrorHtml
# ckStr is a CkString
atom.get_LastErrorHtml(ckStr);
strVal = atom.lastErrorHtml();
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.
topLastErrorText
# ckStr is a CkString
atom.get_LastErrorText(ckStr);
strVal = atom.lastErrorText();
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.
LastErrorXml
# ckStr is a CkString
atom.get_LastErrorXml(ckStr);
strVal = atom.lastErrorXml();
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.
topLastMethodSuccess
boolVal = atom.get_LastMethodSuccess();
atom.put_LastMethodSuccess(boolVal);
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.
topNumEntries
intVal = atom.get_NumEntries();
Number of entries in the Atom document.
topUtf8
boolVal = atom.get_Utf8();
atom.put_Utf8(boolVal);
When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = atom.get_VerboseLogging();
atom.put_VerboseLogging(boolVal);
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.
topVersion
Methods
AddElement
# value is a string
retInt = atom.AddElement(tag, value);
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
# dateTimeStr is a string
retInt = atom.AddElementDateStr(tag, dateTimeStr);
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
# htmlStr is a string
retInt = atom.AddElementHtml(tag, htmlStr);
Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddElementXHtml
# xmlStr is a string
retInt = atom.AddElementXHtml(tag, xmlStr);
Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddElementXml
# xmlStr is a string
retInt = atom.AddElementXml(tag, xmlStr);
Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.
topAddEntry
atom.AddEntry(xmlStr);
Adds an "entry" Atom XML document to the caller's Atom document.
topAddLink
# href is a string
# title is a string
# typ is a string
atom.AddLink(rel, href, title, typ);
Adds a link to the Atom document.
topAddPerson
# name is a string
# uri is a string
# email is a string
atom.AddPerson(tag, name, uri, email);
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
# index is an integer
atom.DeleteElement(tag, index);
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
# index is an integer
# attrName is a string
atom.DeleteElementAttr(tag, index, attrName);
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
# index is an integer
atom.DeletePerson(tag, index);
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
status = atom.DownloadAtom(url);
Download an Atom feed from the Internet and load it into the Atom object.
Returns True for success, False for failure.
topDownloadAtomAsync (1)
Creates an asynchronous task to call the DownloadAtom method with the arguments provided.
Returns None on failure
topGetElement
# index is an integer
# outStr is a CkString (output)
status = atom.GetElement(tag, index, outStr);
retStr = atom.getElement(tag, index);
Returns the content of the Nth element having a specified tag.
Returns True for success, False for failure.
topGetElementAttr
# index is an integer
# attrName is a string
# outStr is a CkString (output)
status = atom.GetElementAttr(tag, index, attrName, outStr);
retStr = atom.getElementAttr(tag, index, attrName);
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 True for success, False for failure.
topGetElementCount
retInt = atom.GetElementCount(tag);
The number of elements having a specific tag.
topGetElementDateStr
# index is an integer
# outStr is a CkString (output)
status = atom.GetElementDateStr(tag, index, outStr);
retStr = atom.getElementDateStr(tag, index);
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 True for success, False for failure.
topGetElementDt
# tag is a string
# index is an integer
ret_ckDateTime = atom.GetElementDt(tag, index);
GetEntry
# index is an integer
ret_atom = atom.GetEntry(index);
GetLinkHref
# outStr is a CkString (output)
status = atom.GetLinkHref(relName, outStr);
retStr = atom.getLinkHref(relName);
Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).
Returns True for success, False for failure.
topGetPersonInfo
# index is an integer
# tag2 is a string
# outStr is a CkString (output)
status = atom.GetPersonInfo(tag, index, tag2, outStr);
retStr = atom.getPersonInfo(tag, index, tag2);
Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").
Returns True for success, False for failure.
topGetTopAttr
# outStr is a CkString (output)
status = atom.GetTopAttr(attrName, outStr);
retStr = atom.getTopAttr(attrName);
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 True for success, False for failure.
topHasElement
retBool = atom.HasElement(tag);
True (1) if the element exists in the Atom document. Otherwise 0.
topLoadTaskCaller
LoadXml
status = atom.LoadXml(xmlStr);
NewEntry
Initializes the Atom document to be a new "entry".
topNewFeed
Initializes the Atom document to be a new "feed".
topSetElementAttr
# index is an integer
# attrName is a string
# attrValue is a string
atom.SetElementAttr(tag, index, attrName, attrValue);
Adds or replaces an attribute on an element.
topSetTopAttr
# value is a string
atom.SetTopAttr(attrName, value);
Adds or replaces an attribute on the top-level XML node of the Atom document.
topToXmlString
UpdateElement
# index is an integer
# value is a string
atom.UpdateElement(tag, index, value);
Replaces the content of an element.
topUpdateElementDateStr
# index is an integer
# dateTimeStr is a string
atom.UpdateElementDateStr(tag, index, dateTimeStr);
Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.
topUpdateElementDt
# index is an integer
# dateTime is a CkDateTime
atom.UpdateElementDt(tag, index, dateTime);
Replaces the content of a date-formatted element.
topUpdateElementHtml
# index is an integer
# htmlStr is a string
atom.UpdateElementHtml(tag, index, htmlStr);
Replaces the content of an HTML element.
topUpdateElementXHtml
# index is an integer
# xmlStr is a string
atom.UpdateElementXHtml(tag, index, xmlStr);
Replaces the content of an XHTML element.
topUpdateElementXml
# index is an integer
# xmlStr is a string
atom.UpdateElementXml(tag, index, xmlStr);
Replaces the content of an XML element.
topUpdatePerson
# index is an integer
# name is a string
# uri is a string
# email is a string
atom.UpdatePerson(tag, index, name, uri, email);
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