Android-builders-club/OsmAnd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

documenting aidl

Browse source
This commit is contained in:
madwasp79 2019-04-05 18:04:16 +03:00
parent d014c7a841
commit 2cbe465fe8
1 changed files with 82 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
OsmAnd/src/net/osmand/aidl/IOsmAndAidlInterface.aidl
View file

@ -112,17 +112,94 @@ interface IOsmAndAidlInterface {
boolean setMapLocation(in SetMapLocationParams params);
boolean calculateRoute(in CalculateRouteParams params);
/**
* Refresh the map (UI)
*/
boolean refreshMap();
/**
* Add favorite group with given params.
*
* @param name - group name.
* @param color - group color. Can be one of: "red", "orange", "yellow",
* "lightgreen", "green", "lightblue", "blue", "purple", "pink", "brown".
* @param visible - group visibility.
*/
boolean addFavoriteGroup(in AddFavoriteGroupParams params);
/**
* Update favorite group with given params.
*
* @param namePrev - group name (current).
* @param colorPrev - group color (current).
* @param visiblePrev - group visibility (current).
* @param nameNew - group name (new).
* @param colorNew - group color (new).
* @param visibleNew - group visibility (new).
*/
boolean removeFavoriteGroup(in RemoveFavoriteGroupParams params);
/**
* Remove favorite group with given name.
*
* @param name - name of favorite group.
*/
boolean updateFavoriteGroup(in UpdateFavoriteGroupParams params);
/**
* Add favorite at given location with given params.
*
* @param lat - latitude.
* @param lon - longitude.
* @param name - name of favorite item.
* @param description - description of favorite item.
* @param category - category of favorite item.
* @param color - color of favorite item. Can be one of: "red", "orange", "yellow",
* "lightgreen", "green", "lightblue", "blue", "purple", "pink", "brown".
* @param visible - should favorite item be visible after creation.
*/
boolean addFavorite(in AddFavoriteParams params);
/**
* Update favorite at given location with given params.
*
* @param latPrev - latitude (current favorite).
* @param lonPrev - longitude (current favorite).
* @param namePrev - name of favorite item (current favorite).
* @param categoryPrev - category of favorite item (current favorite).
* @param latNew - latitude (new favorite).
* @param lonNew - longitude (new favorite).
* @param nameNew - name of favorite item (new favorite).
* @param descriptionNew - description of favorite item (new favorite).
* @param categoryNew - category of favorite item (new favorite). Use only to create a new category,
* not to update an existing one. If you want to update an existing category,
* use the {@link #updateFavoriteGroup(String, String, boolean, String, String, boolean)} method.
* @param colorNew - color of new category. Can be one of: "red", "orange", "yellow",
* "lightgreen", "green", "lightblue", "blue", "purple", "pink", "brown".
* @param visibleNew - should new category be visible after creation.
*/
boolean removeFavorite(in RemoveFavoriteParams params);
/**
* Remove favorite at given location with given params.
*
* @param lat - latitude.
* @param lon - longitude.
* @param name - name of favorite item.
* @param category - category of favorite item.
*/
boolean updateFavorite(in UpdateFavoriteParams params);
/**
* Add map marker at given location.
*
* @param lat - latitude.
* @param lon - longitude.
* @param name - name.
*/
boolean startGpxRecording(in StartGpxRecordingParams params);
boolean stopGpxRecording(in StopGpxRecordingParams params);
boolean takePhotoNote(in TakePhotoNoteParams params);