Method Detail

• addMapMarker

   abstract boolean addMapMarker(AddMapMarkerParams params)

  Add map marker at given location.

• removeMapMarker

   abstract boolean removeMapMarker(RemoveMapMarkerParams params)

  Remove map marker.If ignoreCoordinates is false the marker is only removed if lat/lon match the currently set values of the marker.If ignoreCoordinates is true the marker is removed if the name matches, the values of lat/lon are ignored.

• updateMapMarker

   abstract boolean updateMapMarker(UpdateMapMarkerParams params)

  Update map marker.If ignoreCoordinates is false the marker gets updated only if latPrev/lonPrev match the currently set values of the marker.If ignoreCoordinates is true the marker gets updated if the name matches, the values of latPrev/lonPrev are ignored.

• addMapWidget

   abstract boolean addMapWidget(AddMapWidgetParams params)

  Add map widget to the right side of the main screen.Note: any specified icon should exist in OsmAnd app resources.

• removeMapWidget

   abstract boolean removeMapWidget(RemoveMapWidgetParams params)

  Remove map widget.

• updateMapWidget

   abstract boolean updateMapWidget(UpdateMapWidgetParams params)

  Update map widget.Note: any specified icon should exist in OsmAnd app resources.

• addMapPoint

   abstract boolean addMapPoint(AddMapPointParams params)

  Add point to user layer.

  Parameters:

  params - (Map) - optional map of params for point.

• removeMapPoint

   abstract boolean removeMapPoint(RemoveMapPointParams params)

  Remove point.

• updateMapPoint

   abstract boolean updateMapPoint(UpdateMapPointParams params)

  Update point.

  Parameters:

  params - (Map) - optional map of params for point.

• addMapLayer

   abstract boolean addMapLayer(AddMapLayerParams params)

  Add user layer on the map.

• removeMapLayer

   abstract boolean removeMapLayer(RemoveMapLayerParams params)

  Remove user layer.

• updateMapLayer

   abstract boolean updateMapLayer(UpdateMapLayerParams params)

  Update user layer.

• importGpx

   abstract boolean importGpx(ImportGpxParams params)

  Import GPX file to OsmAnd (from URI or file).

• showGpx

   abstract boolean showGpx(ShowGpxParams params)

  Show GPX file on map.

• hideGpx

   abstract boolean hideGpx(HideGpxParams params)

  Hide GPX file.

• getActiveGpx

   abstract boolean getActiveGpx(List<ASelectedGpxFile> files)

  Get list of active GPX files.

• setMapLocation

   abstract boolean setMapLocation(SetMapLocationParams params)

  Set map view to current location.

• calculateRoute

   abstract boolean calculateRoute(CalculateRouteParams params)

• refreshMap

   abstract boolean refreshMap()

  Refresh the map (UI)

• addFavoriteGroup

   abstract boolean addFavoriteGroup(AddFavoriteGroupParams params)

  Add favorite group with given params.

• removeFavoriteGroup

   abstract boolean removeFavoriteGroup(RemoveFavoriteGroupParams params)

  Remove favorite group with given name.

• updateFavoriteGroup

   abstract boolean updateFavoriteGroup(UpdateFavoriteGroupParams params)

  Update favorite group with given params.

• addFavorite

   abstract boolean addFavorite(AddFavoriteParams params)

  Add favorite at given location with given params.

• removeFavorite

   abstract boolean removeFavorite(RemoveFavoriteParams params)

  Remove favorite at given location with given params.

• updateFavorite

   abstract boolean updateFavorite(UpdateFavoriteParams params)

  Update favorite at given location with given params.

• startGpxRecording

   abstract boolean startGpxRecording(StartGpxRecordingParams params)

  Start gpx recording.

• stopGpxRecording

   abstract boolean stopGpxRecording(StopGpxRecordingParams params)

  Stop gpx recording.

• takePhotoNote

   abstract boolean takePhotoNote(TakePhotoNoteParams params)

  Take photo note.

• startVideoRecording

   abstract boolean startVideoRecording(StartVideoRecordingParams params)

  Start video note recording.

• startAudioRecording

   abstract boolean startAudioRecording(StartAudioRecordingParams params)

  Start audio note recording.

• stopRecording

   abstract boolean stopRecording(StopRecordingParams params)

  Stop Audio/Video recording.

• navigate

   abstract boolean navigate(NavigateParams params)

  Start navigation.

• navigateGpx

   abstract boolean navigateGpx(NavigateGpxParams params)

  Start navigation using gpx file. User need to grant Uri permission to OsmAnd.

• removeGpx

   abstract boolean removeGpx(RemoveGpxParams params)

  Remove GPX file.

• showMapPoint

   abstract boolean showMapPoint(ShowMapPointParams params)

  Show AMapPoint on map in OsmAnd.

  Parameters:

  params - Map- optional map of params for point.

• setNavDrawerItems

   abstract boolean setNavDrawerItems(SetNavDrawerItemsParams params)

  Method for adding up to 3 items to the OsmAnd navigation drawer.

• pauseNavigation

   abstract boolean pauseNavigation(PauseNavigationParams params)

  Put navigation on pause.

• resumeNavigation

   abstract boolean resumeNavigation(ResumeNavigationParams params)

  Resume navigation if it was paused before.

• stopNavigation

   abstract boolean stopNavigation(StopNavigationParams params)

  Stop navigation. Removes target / intermediate points and route path from the map.

• muteNavigation

   abstract boolean muteNavigation(MuteNavigationParams params)

  Mute voice guidance. Stays muted until unmute manually or via the api.

• unmuteNavigation

   abstract boolean unmuteNavigation(UnmuteNavigationParams params)

  Unmute voice guidance.

• search

   abstract boolean search(SearchParams params, IOsmAndAidlCallback callback)

  Run search for POI / Address.

• navigateSearch

   abstract boolean navigateSearch(NavigateSearchParams params)

  Do search and start navigation.

• registerForUpdates

   abstract long registerForUpdates(long updateTimeMS, IOsmAndAidlCallback callback)

  Method to register for periodical callbacks from OsmAnd

  Parameters:

  updateTimeMS - (long)- period of time in millisecond after which callback is triggered

  callback - (IOsmAndCallback)- create and provide instance of IOsmAndAidlCallback interface

• unregisterFromUpdates

   abstract boolean unregisterFromUpdates(long callbackId)

  Method to unregister from periodical callbacks from OsmAnd

  Parameters:

  callbackId - (long)- id of registered callback (provided by OsmAndin registerForUpdates)

• setNavDrawerLogo

  @Deprecated() abstract boolean setNavDrawerLogo(String imageUri)

  Method for adding image to the top of Osmand's NavDrawer.

  Parameters:

  imageUri - (String)- image's URI.

• setEnabledIds

   abstract boolean setEnabledIds(List<String> ids)

  Method for selected UI elements (like QuickSearch button) to show.

  Parameters:

  ids - (List)- list of menu items keys from

• setDisabledIds

   abstract boolean setDisabledIds(List<String> ids)

  Method for selected UI elements (like QuickSearch button) to hide.

  Parameters:

  ids - (List)- list of menu items keys from

• setEnabledPatterns

   abstract boolean setEnabledPatterns(List<String> patterns)

  Method to show selected NavDrawer's menu items.

  Parameters:

  patterns - (List) - list of menu items names from

• setDisabledPatterns

   abstract boolean setDisabledPatterns(List<String> patterns)

  Method to hide selected NavDrawer's menu items.

  Parameters:

  patterns - (List)- list of menu items names from

• regWidgetVisibility

   abstract boolean regWidgetVisibility(SetWidgetsParams params)

  Register OsmAnd widgets for visibility.

• regWidgetAvailability

   abstract boolean regWidgetAvailability(SetWidgetsParams params)

  Register OsmAnd widgets for availability.

• customizeOsmandSettings

   abstract boolean customizeOsmandSettings(OsmandSettingsParams params)

  Add custom parameters for OsmAnd settings to associate with client app.

• getImportedGpx

   abstract boolean getImportedGpx(List<AGpxFile> files)

  Method to get list of gpx files currently registered (imported or created) in OsmAnd;

• getSqliteDbFiles

   abstract boolean getSqliteDbFiles(List<ASqliteDbFile> files)

  Method to get list of sqlitedb files registered in OsmAnd;

• getActiveSqliteDbFiles

   abstract boolean getActiveSqliteDbFiles(List<ASqliteDbFile> files)

  Method to get list of currently active sqlitedb files

• showSqliteDbFile

   abstract boolean showSqliteDbFile(String fileName)

  Method to show selected sqlitedb file as map overlay.

  Parameters:

  fileName - (String) - name of sqlitedb file

• hideSqliteDbFile

   abstract boolean hideSqliteDbFile(String fileName)

  Method to hide sqlitedb file from map overlay.

  Parameters:

  fileName - (String) - name of sqlitedb file

• setNavDrawerLogoWithParams

   abstract boolean setNavDrawerLogoWithParams(NavDrawerHeaderParams params)

  Method for adding image to the top of OsmAnd's NavDrawer with additional params

• setNavDrawerFooterWithParams

   abstract boolean setNavDrawerFooterWithParams(NavDrawerFooterParams params)

  Method for adding functionality to "Powered by Osmand" logo in NavDrawer's footer(reset OsmAnd settings to pre-clinet app's state)

• restoreOsmand

   abstract boolean restoreOsmand()

  Restore default (pre-client) OsmAnd settings and state:clears features, widgets and settings customization, NavDraw logo.

• changePluginState

   abstract boolean changePluginState(PluginParams params)

  Method to change state of plug-ins in OsmAnd.

• registerForOsmandInitListener

   abstract boolean registerForOsmandInitListener(IOsmAndAidlCallback callback)

  Method to register for callback on OsmAnd initialization

  Parameters:

  callback - (IOsmAndAidlCallback) - create and provide instance of IOsmAndAidlCallback interface

• getBitmapForGpx

   abstract boolean getBitmapForGpx(CreateGpxBitmapParams file, IOsmAndAidlCallback callback)

  Requests bitmap snap-shot of map with GPX file from provided URI in its center.You can set bitmap size, density and GPX lines color, but you needto manually download appropriate map in OsmAnd or background will be empty.Bitmap will be returned through callback onGpxBitmapCreated

  Parameters:

  callback - (IOsmAndAidlCallback) - instance of callback from OsmAnd.

• copyFile

   abstract int copyFile(CopyFileParams filePart)

  Method to copy files to OsmAnd part by part. For now supports only sqlitedb format.Part size (bytearray) should not exceed 256k.

• registerForNavigationUpdates

   abstract long registerForNavigationUpdates(ANavigationUpdateParams params, IOsmAndAidlCallback callback)

  Method to register for updates during navgation. Notifies user about distance to the next turn and its type.

  Parameters:

  callback - (IOsmAndAidlCallback) - callback to notify user on navigation data change

• addContextMenuButtons

   abstract long addContextMenuButtons(ContextMenuButtonsParams params, IOsmAndAidlCallback callback)

  Method to add Context Menu buttons to OsmAnd Context menu. ContextMenuButtonsParams is a wrapper class for params:

  Parameters:

  callback - (IOsmAndAidlCallback) - AIDL callback;

• removeContextMenuButtons

   abstract boolean removeContextMenuButtons(RemoveContextMenuButtonsParams params)

  Method to remove Context Menu buttons from OsmAnd Context menu. RemoveContextMenuButtonsParams is a wrapper class for params:

• updateContextMenuButtons

   abstract boolean updateContextMenuButtons(UpdateContextMenuButtonsParams params)

  Method to update params on already set custom Context Button. UpdateContextMenuButtonsParams is a wrapper class for params:

• areOsmandSettingsCustomized

   abstract boolean areOsmandSettingsCustomized(OsmandSettingsInfoParams params)

  Method to check if there is a customized setting in OsmAnd Settings. OsmandSettingsInfoParams is a wrapper class for params:

• setCustomization

   abstract boolean setCustomization(CustomizationInfoParams params)

  Method to customize parameters of OsmAnd.

  Parameters:

  params - (CustomizationInfoParams) - wrapper class for custom settings and ui.

• registerForVoiceRouterMessages

   abstract long registerForVoiceRouterMessages(ANavigationVoiceRouterMessageParams params, IOsmAndAidlCallback callback)

  Method to register for Voice Router voice messages during navigation. Notifies user about voice messages.

• removeAllActiveMapMarkers

   abstract boolean removeAllActiveMapMarkers(RemoveMapMarkersParams params)

  Removes all active map markers (marks them as passed and moves to history)Empty class of params

• importProfile

   abstract boolean importProfile(ProfileSettingsParams params)

• executeQuickAction

   abstract boolean executeQuickAction(QuickActionParams params)

• getQuickActionsInfo

   abstract boolean getQuickActionsInfo(List<QuickActionInfoParams> quickActions)

• setLockState

   abstract boolean setLockState(SetLockStateParams params)

  Toggle Lock/Unlock screen.

• registerForKeyEvents

   abstract long registerForKeyEvents(AKeyEventsParams params, IOsmAndAidlCallback callback)

  Method to register for key events.

• getAppInfo

   abstract AppInfoParams getAppInfo()

• setMapMargins

   abstract boolean setMapMargins(MapMarginsParams params)

• exportProfile

   abstract boolean exportProfile(ExportProfileParams params)

• isFragmentOpen

   abstract boolean isFragmentOpen()

  Is any fragment open.

• isMenuOpen

   abstract boolean isMenuOpen()

  Is contect menu open.

• getPluginVersion

   abstract int getPluginVersion(CustomPluginParams params)

• selectProfile

   abstract boolean selectProfile(SelectProfileParams params)

• getProfiles

   abstract boolean getProfiles(List<AProfile> profiles)

• getBlockedRoads

   abstract boolean getBlockedRoads(List<ABlockedRoad> blockedRoads)

• addRoadBlock

   abstract boolean addRoadBlock(AddBlockedRoadParams params)

• removeRoadBlock

   abstract boolean removeRoadBlock(RemoveBlockedRoadParams params)

• setLocation

   abstract boolean setLocation(SetLocationParams params)

• exitApp

   abstract boolean exitApp(ExitAppParams params)

• getText

   abstract boolean getText(GetTextParams params)

• reloadIndexes

   abstract boolean reloadIndexes()

• setPreference

   abstract boolean setPreference(PreferenceParams params)

• getPreference

   abstract boolean getPreference(PreferenceParams params)

• registerForLogcatMessages

   abstract long registerForLogcatMessages(ALogcatListenerParams params, IOsmAndAidlCallback callback)

  Method to register for Logcat messages. Notifies user about new logs in application.

  Parameters:

  callback - (IOsmAndAidlCallback) - callback to notify user on new OsmAnd logs

• setZoomLimits

   abstract boolean setZoomLimits(ZoomLimitsParams params)

• addWidgetGroup

   abstract boolean addWidgetGroup(AddWidgetGroupParams params)

  Register or update a widget group. Widgets assigned to this group viaAMapWidget.setGroupId(id) are shown together in the "Configure screen".Calling it again with the same id updates the group's name/description/icons.Groups are transient and must be re-registered on each connection.

• removeWidgetGroup

   abstract boolean removeWidgetGroup(RemoveWidgetGroupParams params)

  Remove a widget group. By default its widgets are kept but become ungrouped;set RemoveWidgetGroupParams.removeWidgets = true to also remove the widgets.