IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

GetProperty Method

Fetches the value of a specific Atom feed element or attribute.

Syntax

atom.getProperty(propertyName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method is intended for extending functionality of the Atom class. It will fetch the value for a specific entry element or attribute of this Atom feed. Property is the XPath of the element or attribute according to the following convention: /feed/element@attribute or entry[x]/element@attribute. The @attribute part is optional.

entry[x] is the Channel's xth entry (or any other root level child), where the indexer x starts at 1.

element is any child of the Channel or an entry, and attribute can be any attribute of that field. If an attribute is not supplied, the GetProperty method will return the text portion of element. For example:


  AtomControl.GetProperty("entry[5]/link@href")
  AtomControl.GetProperty("entry[5]/author/name")
  AtomControl.GetProperty("/feed/title")

Note: in order to add non-standard fields (i.e. fields that are not defined in the Atom specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0