HeadingResponse
  • Android 0.8
  • iPhone 0.8
  • iPad 0.8
ErrorResponse
> HeadingResponse

Argument passed to the getCurrentHeading callback.

  • 0.8
  • 0.8
  • 0.8

NOTE This is an abstract type. Any object meeting this description can be used where this type is used.

Defined By

Properties

HeadingResponse
code : Number

Error code.

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.

  • 0.8
  • 0.8

Overrides: ErrorResponse.code

HeadingResponse
error : String

Error message, if any returned.

Error message, if any returned.

Will be undefined if success is true.

  • 0.8
  • 0.8

Overrides: ErrorResponse.error

HeadingResponse
heading : HeadingData

If success is true, the actual heading data.

If success is true, the actual heading data.

HeadingResponse
success : Boolean

Indicates a successful operation.

Indicates a successful operation.

Returns true if request succeeded, false otherwise.

  • 0.8
  • 0.8

Overrides: ErrorResponse.success