GetProperty Method

Get the value of a specific Google Data feed element or attribute.

Syntax

gcontacts.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 GData class. It will get the value for a specific entry element or attribute of this GData feed. PropertyName 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. When EntryIndex is set to an index greater than zero, a relative path can also be used: /element or /element@attribute. When a relative path is specified, the value of the specified PropertyName will be returned for the entry identified by EntryIndex.

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

element is any child of the feed 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:

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

Here is an example using a relative path to retrieve properties of the first feed entry:

	GDataControl.EntryIndex = 1
	GDataControl.GetProperty("id")
	GDataControl.GetProperty("link@href")
	GDataControl.GetProperty("gd:name/gd:fullName")