CkoAtom Swift Reference Documentation

CkoAtom

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

Properties

AbortCurrent: Bool (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.)

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.

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.

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.

Concept of LastErrorText

LastErrorText Standard Information

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.

LastMethodSuccess: 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.

NumEntries: Int (read-only)

Number of entries in the Atom document.

VerboseLogging: 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.

Version: String (read-only)

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

Methods

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.

AddElementDate(tag: String, dateTime: NSDate) -> Int

This method is deprecated. It will be removed in a future version.

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.

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.

AddElementDt(tag: String, dateTime: CkoDateTime) -> 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.

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.

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.

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.

AddEntry(xmlStr: String)

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

AddLink(rel: String, href: String, title: String, typ: String)

Adds a link to the Atom document.

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.

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.

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

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.

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.

DownloadAtomAsync(url: String) -> CkoTask

Creates an asynchronous task to call the DownloadAtom 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

How to Run an Asynchronous Task

GetElement(tag: String, index: Int) -> String

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

Returns nil on failure

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

GetElementCount(tag: String) -> Int

The number of elements having a specific tag.

GetElementDate(tag: String, index: Int) -> NSDate

This method is deprecated. It will be removed in a future version.

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

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

GetElementDt(tag: String, index: Int) -> CkoDateTime

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

Returns nil on failure

GetEntry(index: Int) -> CkoAtom

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

Returns nil on failure

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

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

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

HasElement(tag: String) -> Bool

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

LoadXml(xmlStr: String) -> Bool

Loads the Atom document from an XML string.

Returns true for success, false for failure.

NewEntry()

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

NewFeed()

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

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.

SetElementAttr(tag: String, index: Int, attrName: String, attrValue: String)

Adds or replaces an attribute on an element.

SetTopAttr(attrName: String, value: String)

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

ToXmlString() -> String

Serializes the Atom document to an XML string.

Returns nil on failure

UpdateElement(tag: String, index: Int, value: String)

Replaces the content of an element.

UpdateElementDate(tag: String, index: Int, dateTime: NSDate)

This method is deprecated. It will be removed in a future version.

Replaces the content of a date-formatted element.

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.

UpdateElementDt(tag: String, index: Int, dateTime: CkoDateTime)

Replaces the content of a date-formatted element.

UpdateElementHtml(tag: String, index: Int, htmlStr: String)

Replaces the content of an HTML element.

UpdateElementXHtml(tag: String, index: Int, xmlStr: String)

Replaces the content of an XHTML element.

UpdateElementXml(tag: String, index: Int, xmlStr: String)

Replaces the content of an XML element.

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.

Events

To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.

For example:

class MyAtomProgress : CkoBaseProgress {

    override func ProgressInfo(name: String!, value: String!) {
        // application code goes here...
        print(name + ": " + value)
    }

    override func AbortCheck(abort: UnsafeMutablePointer) {
        // application code goes here...
        // To abort the operation, set this equal to true instead of false.
        abort.memory = false
    }

    override func PercentDone(pctDone: NSNumber!, abort: UnsafeMutablePointer) {
        // application code goes here...
        print(pctDone)
        // To abort the operation, set this equal to true instead of false.
        abort.memory = false
    }

    // For asynchronous method calls.
    override func TaskCompleted(task: CkoTask!) {
        // application code goes here...
    }
}

func someAppFunction() {

    // Demonstrate how to set the event callback object...
    let atom = CkoAtom()
    let myAtomProgress = MyAtomProgress()
    
    atom.setEventCallbackObject(myAtomProgress)

    // ...
    // ...
    // ...
}

AbortCheck(abort: Bool)

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.

BinaryData(data: NSData, length: UInt)

Binary data provided by certain methods.

PercentDone(pctDone: Int, abort: Bool)

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.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

ProgressInfo(name: String, value: String)

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.

TaskCompleted(task: CkoTask)

Called in the background thread when an asynchronous task completes.

TextData(data: String)

Text data provided by certain methods.