RouteInstruction

RouteInstruction object

Constructors

Link copied to clipboard
constructor()
constructor(address: Long)
constructor(address: Long, isRef: Boolean)

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

Coordinates for this route instruction.

Link copied to clipboard

ISO 3166-1 alpha-3 country code for the navigation instruction. Empty string means no country. See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

Link copied to clipboard

Textual description for the follow road information.

Link copied to clipboard
Link copied to clipboard

Image for the realistic next turn. The API client is should check if the image is valid.

Link copied to clipboard

Remaining travel distance in meters and remaining traveling time in seconds.

Remaining traveling time in seconds to the next way point and the remaining travel distance in meters to the next way point.

Link copied to clipboard

Road info

Link copied to clipboard

Road info image

Link copied to clipboard

Extended signpost details.

Link copied to clipboard

Textual description for the signpost information.

Link copied to clipboard

Distance to the next turn in meters, time in seconds.

Link copied to clipboard

Traveled distance in meters and the traveled time in seconds.

Link copied to clipboard

Full details for the turn. This may be used instead of GetTurnIcon in order to customize display in UI.

Link copied to clipboard

The image for the turn. The API client is should check if the image is valid.

Link copied to clipboard

Textual description for the turn.

Functions

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun hasFollowRoadInfo(): Boolean

Checks if follow road information is available.

Link copied to clipboard
external fun hasSignpostInfo(): Boolean

Checks if signpost information is available.

Link copied to clipboard
external fun hasTurnInfo(): Boolean

Checks if turn information is available.

Link copied to clipboard
external fun isCommon(): Boolean

Check if this instruction is of common type.

Link copied to clipboard
external fun isFerry(): Boolean

Returns true is the route instruction is a ferry

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
external fun isTollRoad(): Boolean

Returns true is the route instruction is a toll road

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard

Casts this Route instruction to a Public transport instruction.