EntryETag Property

The ETag of the current entry in an OData feed.

Syntax

 odata.getEntryETag([callback])
 odata.setEntryETag( entryETag, [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 getEntryETag([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 setEntryETag([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 is used to obtain the ETag of the specified entry within an OData feed and will be populated once EntryIndex is set.

This property is also used when retrieving, updating or deleting an entry. When EntryETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an "If-Match" header will be sent with the entered value.

This property is not available at design time.

Data Type

String