Atom Go Reference Documentation

Atom

Current Version: 9.5.0.82

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

Object Creation

atom := chilkat.NewAtom()
...
atom.DisposeAtom()

Properties

AbortCurrent
func (atom *Atom) AbortCurrent() bool
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
func (atom *Atom) DebugLogFilePath() string
func (atom *Atom) SetDebugLogFilePath(s 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
func (atom *Atom) LastErrorHtml() string

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
func (atom *Atom) LastErrorText() string

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
func (atom *Atom) LastErrorXml() string

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
func (atom *Atom) LastMethodSuccess() bool
func (atom *Atom) SetLastMethodSuccess(b bool)
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
NumEntries
func (atom *Atom) NumEntries() int

Number of entries in the Atom document.

top
VerboseLogging
func (atom *Atom) VerboseLogging() bool
func (atom *Atom) SetVerboseLogging(b bool)

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
func (atom *Atom) Version() string

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

top

Methods

AddElement
func (atom *Atom) AddElement(tag string, value string) int

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
func (atom *Atom) AddElementDateStr(tag string, dateTimeStr string) int

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
func (atom *Atom) AddElementDt(tag string, dateTime *CkDateTime) int

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
func (atom *Atom) AddElementHtml(tag string, htmlStr string) int

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

top
AddElementXHtml
func (atom *Atom) AddElementXHtml(tag string, xmlStr string) int

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

top
AddElementXml
func (atom *Atom) AddElementXml(tag string, xmlStr string) int

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

top
AddEntry
func (atom *Atom) AddEntry(xmlStr string)

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

top
AddLink
func (atom *Atom) AddLink(rel string, href string, title string, typ string)

Adds a link to the Atom document.

top
AddPerson
func (atom *Atom) AddPerson(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
func (atom *Atom) DeleteElement(tag string, index int)

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
func (atom *Atom) DeleteElementAttr(tag string, index int, 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
func (atom *Atom) DeletePerson(tag string, index int)

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
func (atom *Atom) DownloadAtom(url string) bool

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

Returns true for success, false for failure.

top
DownloadAtomAsync (1)
func (atom *Atom) DownloadAtomAsync(url string) *Task

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

top
GetElement
func (atom *Atom) GetElement(tag string, index int) *string

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

Returns nil on failure

top
GetElementAttr
func (atom *Atom) GetElementAttr(tag string, index int, attrName string) *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 nil on failure

top
GetElementCount
func (atom *Atom) GetElementCount(tag string) int

The number of elements having a specific tag.

top
GetElementDateStr
func (atom *Atom) GetElementDateStr(tag string, index int) *string

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

top
GetElementDt
func (atom *Atom) GetElementDt(tag string, index int) *CkDateTime

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

Returns nil on failure

top
GetEntry
func (atom *Atom) GetEntry(index int) *Atom

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

Returns nil on failure

top
GetLinkHref
func (atom *Atom) GetLinkHref(relName string) *string

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

Returns nil on failure

top
GetPersonInfo
func (atom *Atom) GetPersonInfo(tag string, index int, tag2 string) *string

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

Returns nil on failure

top
GetTopAttr
func (atom *Atom) GetTopAttr(attrName string) *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 nil on failure

top
HasElement
func (atom *Atom) HasElement(tag string) bool

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

top
LoadTaskCaller
func (atom *Atom) LoadTaskCaller(task *Task) bool
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
func (atom *Atom) LoadXml(xmlStr string) bool

Loads the Atom document from an XML string.

Returns true for success, false for failure.

top
NewEntry
func (atom *Atom) NewEntry()

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

top
NewFeed
func (atom *Atom) NewFeed()

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

top
SaveLastError
func (atom *Atom) SaveLastError(path string) bool

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

Returns true for success, false for failure.

top
SetElementAttr
func (atom *Atom) SetElementAttr(tag string, index int, attrName string, attrValue string)

Adds or replaces an attribute on an element.

top
SetTopAttr
func (atom *Atom) SetTopAttr(attrName string, value string)

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

top
ToXmlString
func (atom *Atom) ToXmlString() *string

Serializes the Atom document to an XML string.

Returns nil on failure

top
UpdateElement
func (atom *Atom) UpdateElement(tag string, index int, value string)

Replaces the content of an element.

top
UpdateElementDateStr
func (atom *Atom) UpdateElementDateStr(tag string, index int, dateTimeStr string)

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

top
UpdateElementDt
func (atom *Atom) UpdateElementDt(tag string, index int, dateTime *CkDateTime)

Replaces the content of a date-formatted element.

top
UpdateElementHtml
func (atom *Atom) UpdateElementHtml(tag string, index int, htmlStr string)

Replaces the content of an HTML element.

top
UpdateElementXHtml
func (atom *Atom) UpdateElementXHtml(tag string, index int, xmlStr string)

Replaces the content of an XHTML element.

top
UpdateElementXml
func (atom *Atom) UpdateElementXml(tag string, index int, xmlStr string)

Replaces the content of an XML element.

top
UpdatePerson
func (atom *Atom) UpdatePerson(tag string, index int, 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