# HeadingResponse

Argument passed to the getCurrentHeading callback.

Availability

0.8

9.2.0

Extends

ErrorResponse

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# code

Availability

0.8

9.2.0

code :Number

Error code.

Error code will be 0 if success is true, nonzero otherwise. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.

# error

Availability

0.8

9.2.0

error :String

Error message, if any returned.

Will be undefined if success is true.

# heading

Availability

0.8

9.2.0

heading :HeadingData

If success is true, the actual heading data.

# success

Availability

0.8

9.2.0

success :Boolean

Indicates a successful operation.

Returns true if request succeeded, false otherwise.