ApiEvents class enumerates events that Navigation can generate. More...

Static Public Attributes
static final int	EVENT_APP_STARTED = 1010
	Event occurs when navigation has started.
static final int	EVENT_ROUTE_USERCANCEL = 1101
	Event occurs when user destroys route.
static final int	EVENT_WAIPOINT_VISITED = 1102
	Event occurs when a waipoint is visited.
static final int	EVENT_ROUTE_FINISH = 1103
	Event occurs when the end of the route is reached.
static final int	EVENT_ROUTE_COMPUTED = 1105
	Event occurs when new route is computed.
static final int	EVENT_OFF_ROUTE = 1106
	Event occurs when a route is recomputed.
static final int	EVENT_OFF_ROUTE_EXT = 1110
	Event occurs when a route is recomputed.
static final int	EVENT_OFF_ROUTE_PRECOMPUTED = 1111
	Event occurs after deviation from precomputed route.
static final int	EVENT_OPTIMIZATION_FINISHED = 1107
	Event occurs when optimization is finished.
static final int	EVENT_ITINERARY_CHANGED = 1108
	Event occurs when itinerary has been changed manually.
static final int	EVENT_ITINERARY_WARNING = 1109
	Event occurs when ETA to one or more of the itinerary waypoints is not in time window.
static final int	EVENT_APP_EXIT = 1100
	Event occurs when application exits or internal error occurs.
static final int	EVENT_MAIN_MENU = 1150
	Event occurs when user click on the navigation window.
static final int	EVENT_CONTEXT_MENU = 1151
	Event occurs when user show context menu.
static final int	EVENT_EXIT_MENU = 1152
	Event occurs when return to navigation from any menu.
static final int	EVENT_CUSTOM_MENU = 1153
	Event occurs after the user clicks on some custom button in the menu.
static final int	EVENT_ENTER_MENU = 1154
	Event occurs when user enters a menu dialog from navigation window.
static final int	EVENT_CHANGE_LANGUAGE = 1160
	Event occurs when user change language of Drive application.
static final int	EVENT_CHANGE_ORIENTATION = 1161
	Deprecated.
static final int	EVENT_RADAR_WARNING = 1170
	Event occurs when a radar warning is invoked.
static final int	EVENT_POI_WARNING = 1171
	Event occurs when a poi warning is invoked.
static final int	EVENT_GEOFENCE = 1172
	Event occurs when a geofence event is invoked.
static final int	EVENT_RESTRICTED_ROAD = 1173
	Event occurs when on a restricted road.
static final int	EVENT_BORDER_CROSSING = 1180
	Event occurs when the border is crossed.
static final int	EVENT_SPEED_EXCEEDING = 1181
	Event occurs when the speed is exceeded.
static final int	EVENT_SPEED_LIMIT_CHANGED = 1182
	Event occurs when the speed limit is changed.
static final int	BITMAP_CLICK = 1190
	Event occurs when the bitmap is clicked.
static final int	EVENT_POI_CLICK = 1191
	Event occurs when the poi is clicked.
static final int	EVENT_WAYPOINT_CLICKED = 1192
	Waypoint was clicked.
static final int	EVENT_SHARE_POSITION = 1193
	Position was shared from the app menu (Special setting must be turned on to enable this feature).
static final int	EVENT_BROWSE_MAP_EXIT = 1194
	Event occurs when you exit browsing map.
static final int	EVENT_WAYPOINT_MARKED_AS_VISITED = 1195
	Event occurs when waypoint is marked as visited.
static final int	EVENT_CALLBACK = 2000
	not used

Detailed Description

ApiEvents class enumerates events that Navigation can generate.

Navigation events can be processed by registering a callback with remote app.

Member Data Documentation

◆ BITMAP_CLICK

final int BITMAP_CLICK = 1190

static

Event occurs when the bitmap is clicked.

◆ EVENT_APP_EXIT

final int EVENT_APP_EXIT = 1100

static

Event occurs when application exits or internal error occurs.

◆ EVENT_APP_STARTED

final int EVENT_APP_STARTED = 1010

static

Event occurs when navigation has started.

◆ EVENT_BORDER_CROSSING

final int EVENT_BORDER_CROSSING = 1180

static

Event occurs when the border is crossed.

◆ EVENT_BROWSE_MAP_EXIT

final int EVENT_BROWSE_MAP_EXIT = 1194

static

Event occurs when you exit browsing map.

◆ EVENT_CALLBACK

final int EVENT_CALLBACK = 2000

static

not used

◆ EVENT_CHANGE_LANGUAGE

final int EVENT_CHANGE_LANGUAGE = 1160

static

Event occurs when user change language of Drive application.

The strData contains the name of the lang file, e.g. the user selects English in the menu, so it returns "english.lang"

◆ EVENT_CHANGE_ORIENTATION

final int EVENT_CHANGE_ORIENTATION = 1161

static

Deprecated.

Event used to occur when user changed screen orientation of Navigation application. The event is not generated on Android anymore.

◆ EVENT_CONTEXT_MENU

final int EVENT_CONTEXT_MENU = 1151

static

Event occurs when user show context menu.

◆ EVENT_CUSTOM_MENU

final int EVENT_CUSTOM_MENU = 1153

static

Event occurs after the user clicks on some custom button in the menu.

The strData parameter will return the command parameter (defined in menu.ini file) of this button.

◆ EVENT_ENTER_MENU

final int EVENT_ENTER_MENU = 1154

static

Event occurs when user enters a menu dialog from navigation window.

◆ EVENT_EXIT_MENU

final int EVENT_EXIT_MENU = 1152

static

Event occurs when return to navigation from any menu.

◆ EVENT_GEOFENCE

final int EVENT_GEOFENCE = 1172

static

Event occurs when a geofence event is invoked.

The strData parameter has the following format: "%d,%d"
the first parameter is geofence event type. 0 means enter to the restricted area, 1 means leave the restricted area. the second parameter is restricted area ID.

◆ EVENT_ITINERARY_CHANGED

final int EVENT_ITINERARY_CHANGED = 1108

static

Event occurs when itinerary has been changed manually.

◆ EVENT_ITINERARY_WARNING

final int EVENT_ITINERARY_WARNING = 1109

static

Event occurs when ETA to one or more of the itinerary waypoints is not in time window.

◆ EVENT_MAIN_MENU

final int EVENT_MAIN_MENU = 1150

static

Event occurs when user click on the navigation window.

◆ EVENT_OFF_ROUTE

final int EVENT_OFF_ROUTE = 1106

static

Event occurs when a route is recomputed.

◆ EVENT_OFF_ROUTE_EXT

final int EVENT_OFF_ROUTE_EXT = 1110

static

Event occurs when a route is recomputed.

Data contains information about itinerary ID.

◆ EVENT_OFF_ROUTE_PRECOMPUTED

final int EVENT_OFF_ROUTE_PRECOMPUTED = 1111

static

Event occurs after deviation from precomputed route.

Data contains information about itinerary ID. [RuntimeSettings]m_nOffRouteExtDistance has to be set to fire this event.

◆ EVENT_OPTIMIZATION_FINISHED

final int EVENT_OPTIMIZATION_FINISHED = 1107

static

Event occurs when optimization is finished.

Data is "0" if optimization was successful, other value otherwise.

◆ EVENT_POI_CLICK

final int EVENT_POI_CLICK = 1191

static

Event occurs when the poi is clicked.

Data contains string "{category_name},{poi_name},{lon,lat}"

◆ EVENT_POI_WARNING

final int EVENT_POI_WARNING = 1171

static

Event occurs when a poi warning is invoked.

The strData parameter has following format: "%s,%s,{%d,%d}"
the first parameter is category name (use ApiPoi#getPoiCategoryList(int) function to get list of poi categories)
the second parameter is poi name
the third parameter is longitude
the fourth parameter is latitude

◆ EVENT_RADAR_WARNING

final int EVENT_RADAR_WARNING = 1170

static

Event occurs when a radar warning is invoked.

The strData parameter has following format: "%d,%d"
first parameter is speed camera type (see Api.SpeedCameraType enum)
second parameter is allowed speed (km / h)

◆ EVENT_RESTRICTED_ROAD

final int EVENT_RESTRICTED_ROAD = 1173

static

Event occurs when on a restricted road.

◆ EVENT_ROUTE_COMPUTED

final int EVENT_ROUTE_COMPUTED = 1105

static

Event occurs when new route is computed.

◆ EVENT_ROUTE_FINISH

final int EVENT_ROUTE_FINISH = 1103

static

Event occurs when the end of the route is reached.

◆ EVENT_ROUTE_USERCANCEL

final int EVENT_ROUTE_USERCANCEL = 1101

static

Event occurs when user destroys route.

◆ EVENT_SHARE_POSITION

final int EVENT_SHARE_POSITION = 1193

static

Position was shared from the app menu (Special setting must be turned on to enable this feature).

Data contains JSON: { "lat": (int), "lon": (int) }

◆ EVENT_SPEED_EXCEEDING

final int EVENT_SPEED_EXCEEDING = 1181

static

Event occurs when the speed is exceeded.

◆ EVENT_SPEED_LIMIT_CHANGED

final int EVENT_SPEED_LIMIT_CHANGED = 1182

static

Event occurs when the speed limit is changed.

◆ EVENT_WAIPOINT_VISITED

final int EVENT_WAIPOINT_VISITED = 1102

static

Event occurs when a waipoint is visited.

The strData parameter will return the waypoint ID.

◆ EVENT_WAYPOINT_CLICKED

final int EVENT_WAYPOINT_CLICKED = 1192

static

Waypoint was clicked.

Data contains ID of waypoint (if set) or order of waypoint in itinerary (if ID was not set)

◆ EVENT_WAYPOINT_MARKED_AS_VISITED

final int EVENT_WAYPOINT_MARKED_AS_VISITED = 1195

static

Event occurs when waypoint is marked as visited.

Data contains info about waypoint ID and trigger of this event ("manual" or "sdk")

Static Public Attributes

Detailed Description

Member Data Documentation

◆ BITMAP_CLICK

◆ EVENT_APP_EXIT

◆ EVENT_APP_STARTED

◆ EVENT_BORDER_CROSSING

◆ EVENT_BROWSE_MAP_EXIT

◆ EVENT_CALLBACK

◆ EVENT_CHANGE_LANGUAGE

◆ EVENT_CHANGE_ORIENTATION

◆ EVENT_CONTEXT_MENU

◆ EVENT_CUSTOM_MENU

◆ EVENT_ENTER_MENU

◆ EVENT_EXIT_MENU

◆ EVENT_GEOFENCE

◆ EVENT_ITINERARY_CHANGED

◆ EVENT_ITINERARY_WARNING

◆ EVENT_MAIN_MENU

◆ EVENT_OFF_ROUTE

◆ EVENT_OFF_ROUTE_EXT

◆ EVENT_OFF_ROUTE_PRECOMPUTED

◆ EVENT_OPTIMIZATION_FINISHED

◆ EVENT_POI_CLICK

◆ EVENT_POI_WARNING

◆ EVENT_RADAR_WARNING

◆ EVENT_RESTRICTED_ROAD

◆ EVENT_ROUTE_COMPUTED

◆ EVENT_ROUTE_FINISH

◆ EVENT_ROUTE_USERCANCEL

◆ EVENT_SHARE_POSITION

◆ EVENT_SPEED_EXCEEDING

◆ EVENT_SPEED_LIMIT_CHANGED

◆ EVENT_WAIPOINT_VISITED

◆ EVENT_WAYPOINT_CLICKED

◆ EVENT_WAYPOINT_MARKED_AS_VISITED