Android Java SDK for Sygic 3D
ApiEvents Class Reference

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. More...
 
static final int EVENT_ROUTE_USERCANCEL = 1101
 Event occurs when user destroys route. More...
 
static final int EVENT_WAIPOINT_VISITED = 1102
 Event occurs when a waipoint is visited. More...
 
static final int EVENT_ROUTE_FINISH = 1103
 Event occurs when the end of the route is reached. More...
 
static final int EVENT_ROUTE_COMPUTED = 1105
 Event occurs when new route is computed. More...
 
static final int EVENT_OFF_ROUTE = 1106
 Event occurs when a route is recomputed. More...
 
static final int EVENT_OPTIMIZATION_FINISHED = 1107
 Event occurs when optimization is finished. More...
 
static final int EVENT_ITINERARY_CHANGED = 1108
 Event occurs when itinerary has been changed manually. More...
 
static final int EVENT_ITINERARY_WARNING = 1109
 Event occurs when ETA to one or more of the itinerary waypoints is not in time window. More...
 
static final int EVENT_APP_EXIT = 1100
 Event occurs when application exits or internal error occurs. More...
 
static final int EVENT_MAIN_MENU = 1150
 Event occurs when user click on the navigation window. More...
 
static final int EVENT_CONTEXT_MENU = 1151
 Event occurs when user show context menu. More...
 
static final int EVENT_EXIT_MENU = 1152
 Event occurs when return to navigation from any menu. More...
 
static final int EVENT_CUSTOM_MENU = 1153
 Event occurs after the user clicks on some custom button in the menu. More...
 
static final int EVENT_CHANGE_LANGUAGE = 1160
 Event occurs when user change language of Drive application. More...
 
static final int EVENT_CHANGE_ORIENTATION = 1161
 Deprecated. More...
 
static final int EVENT_RADAR_WARNING = 1170
 Event occurs when a radar warning is invoked. More...
 
static final int EVENT_POI_WARNING = 1171
 Event occurs when a poi warning is invoked. More...
 
static final int EVENT_GEOFENCE = 1172
 Event occurs when a geofence event is invoked. More...
 
static final int EVENT_RESTRICTED_ROAD = 1173
 Event occurs when on a restricted road. More...
 
static final int EVENT_BORDER_CROSSING = 1180
 Event occurs when the border is crossed. More...
 
static final int EVENT_SPEED_EXCEEDING = 1181
 Event occurs when the speed is exceeded. More...
 
static final int EVENT_SPEED_LIMIT_CHANGED = 1182
 Event occurs when the speed limit is changed. More...
 
static final int BITMAP_CLICK = 1190
 Event occurs when the bitmap is clicked. More...
 
static final int EVENT_POI_CLICK = 1191
 Event occurs when the poi is clicked. More...
 
static final int EVENT_CALLBACK = 2000
 not used More...
 

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_CALLBACK

final int EVENT_CALLBACK = 2000
static

not used

Referenced by Api.getInstance().

◆ 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_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_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.

◆ 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_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.