EntrySummary Property

The Summary of the current entry in an OData feed.

Syntax

 odata.getEntrySummary([callback])
 odata.setEntrySummary( entrySummary, [callback])

Default Value

""

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 the getEntrySummary([callback]) 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.

The callback for the setEntrySummary([callback]) method is defined as:

function(err){ }

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

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the Summary of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Summary can be found).

This property is not available at design time.

Data Type

String