Skip to content

AmiraMostafaAhmed/tmaps-android-sample

BranchesTags
 
 

Repository files navigation

tmaps-android-sample

Installation

To integrate TMaps into your Android Studio project, add it to your project:

  1. Create folder named tmapswww
  2. Download and Unzip map package inside tmapswww (Request map package from Tagipedia Team)
  3. Read our sample for examples

How it works

it works using dispatch actions between your APP and TMaps. So your APP dispatch actions to TMaps and TMaps dispatch actions to your APP.

Usage

Allow Reload map from JS

IMPORTANT: You should inject this script into webview because it is called from TMap when TMap need to reload webview. if you don't inject it webview will not reloaded.

mWebView.addJavascriptInterface(new JavascriptInterface(){
      @JavascriptInterface
      public void reload() {
          runOnUiThread(new Runnable() { @Override public void run() { mWebView.reload(); } });
      }
},"__tmaps_bridge__");
String tbString = "window.__reload__ = function(){__tmaps_bridge__.reload();};";
injectScript(tbString);

TMaps actions dispatched to Your APP

Ready

dispatched when TMaps ready to receive dispatches from Your APP. So you should not dispatch any action before TMaps get ready.

new HashMap<String, Object>(){{
   put("type", "READY");
}};

Map loaded

dispatched when map loaded and visible to user.

new HashMap<String, Object>(){{
   put("type", "MAP_LOADED");
}};

Features tapped

dispatched when features in map tapped.

new HashMap<String, Object>(){{
   put("type", "FEATURES_TAPPED");
   put("features", features);
}};

    features
    Required List with Map, each Map with id, properties keys

Associated feature tapped

dispatched when features in map tapped with the top feature visible to user.

new HashMap<String, Object>(){{
   put("type", "ASSOCIATED_FEATURE_TAPPED");
   put("feature_id", feature_id);
   put("feature", feature);
}};

    feature_id
    Required String with valid feature id

    feature
    Required Map with id, properties keys

Category marked

dispatched when select category in map

new HashMap<String, Object>(){{
   put("type", "CATEGORY_MARKED");
   put("category", category);
}};

    category
    Required valid String category

Error

dispatched when error happened in TMaps

new HashMap<String, Object>(){{
   put("type", "ERROR");
   put("error", error);
}};

    error
    Required Map with stack key and String value

Feature marked

dispatched after MARK_FEATURE ended

new HashMap<String, Object>(){{
  put("type", "FEATURE_MARKED");
  put("feature_id", feature_id);
}};

    feature_id
    Required String with valid feature id

Feature highlighted

dispatched after HIGHLIGHT_FEATURE ended

new HashMap<String, Object>(){{
  put("type", "FEATURE_HIGHLIGHTED");
  put("feature_id", feature_id);
}};

    feature_id
    Required String with valid feature id

Zoom ended

dispatched after SET_ZOOM ended

new HashMap<String, Object>(){{
  put("type", "ZOOM_ENDED");
}};

Center ended

dispatched after SET_CENTER ended

new HashMap<String, Object>(){{
  put("type", "CENTER_ENDED");
}};

Event logged

dispatched after any event happened in TMaps. Your app can send analytics after receive this action.

new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Maps");
  put("event_action", "Loaded");
  put("event_label", map_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Features");
  put("event_action", "Tapped");
  put("event_label", feature_display_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("feature_id", feature_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Features");
  put("event_action", "Highlighted");
  put("event_label", feature_display_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("feature_id", feature_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Features");
  put("event_action", "Searched");
  put("event_label", feature_display_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("feature_id", feature_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Categories");
  put("event_action", "Highlighted");
  put("event_label", category);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Categories");
  put("event_action", "Searched");
  put("event_label", category);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Routes");
  put("event_action", "Routed");
  put("event_label", source_display_name => target_display_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("source_feature_id", source_feature_id);
      put("target_feature_id", target_feature_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Buildings");
  put("event_action", "Tapped");
  put("event_label", building_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("building_id", building_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Buildings");
  put("event_action", "Opened");
  put("event_label", building_name);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("building_id", building_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "Floors");
  put("event_action", "Opened");
  put("event_label", floor_label);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("layer_id", layer_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "RenderModes");
  put("event_action", "Changed");
  put("event_label", render_mode);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "LocationUpdated");
  put("event_action", "Gps");
  put("event_label", latitude/longitude);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("lat", latitude);
      put("lng", longitude);
  }});
}};
new HashMap<String, Object>(){{
  put("type", "EVENT_LOGGED");
  put("event_category", "LocationUpdated");
  put("event_action", "Beacon");
  put("event_label", latitude/longitude);
  put("fields_object", new HashMap<String, Object>(){{
      put("map_id", map_id);
      put("lat", latitude);
      put("lng", longitude);
  }});
}};

Check Location Service

dispatched after Tapped GPS Button in TMaps. You Should turn on Location Service and then dispatch Start to begin updating location

new HashMap<String, Object>(){{
  put("type", "CHECK_GPS_AVAILABILITY");
}};

Check Beacon Location Service

dispatched after Tapped Beacon Location Button in TMaps. You Should turn on Bluetooth Service and then dispatch Start to begin updating location

new HashMap<String, Object>(){{
  put("type", "CHECK_BEACON_LOCATION_AVAILABILITY");
}};

Start Beacon Location Manager

dispatched after starting updating beacon location in TMaps. You Should start or stop beacon manager according to beacon manager state. if beacon manager state is true you shoud start beacon manager then dispatch the new position to TMaps to update user location

new HashMap<String, Object>(){{
  put("type", "START_POSITION_UPDATES_FOR_BEACON_LOCATION");
  put("start_beacon_manager",start_beacon_manager);
}};

    start_beacon_manager
    Required boolean beacon manager state

Your APP actions dispatched to TMaps

Set tenant data

dispatch it to set tenants of map.

new HashMap<String, Object>(){{
  put("type", "SET_TENANT_DATA");
  put("payload", tenants_json);
}}

    payload
    Required List with Map, each Map with id, feature_id, name, booth_id, icon, CUSTOM_KEYS_YOU_NEED keys

Set default feature popup template

dispatch it to change default feature popup template.

new HashMap<String, Object>(){{
  put("type", "SET_DEFAULT_FEATURE_POPUP_TEMPLATE");
  put("template", template);
  put("template_custom_data", templateCustomData);
}}

    template
    Required valid String angular template with PopupScope

    template_custom_data
    Optional Map with CUSTOM_KEYS_YOU_NEED keys and String, Number, List, Map values
template custom data of keys that you want to use from customData in PopupScope

Set theme

dispatch it to change theme of map.

new HashMap<String, Object>(){{
  put("primary", primary_color);
  put("accent", accent_color);
}}

    primary
    Optional valid String color

    accent
    Optional valid String color

Load map

dispatch it to load map.

new HashMap<String, Object>(){{
  put("type", "LOAD_MAP");
  put("map_id", map_id);
  put("theme", new HashMap<String, Object>(){{
     put("primary", primary_color);
     put("accent", accent_color);
  }});
  put("center", Arrays.asList(lng, lat));
  put("zoom", zoom);
}}

    map_id
    Required String

    theme
    Optional Map with primary, accent keys and valid String color values theme used for colors such as buttons and loading

    center
    Optional List of Numbers Default map center in longitude and latitude

    zoom
    Optional Number Default zoom level

Change render mode

dispatch it to change render mode.

new HashMap<String, Object>(){{
  put("type", "CHANGE_RENDER_MODE");
  put("modeToRender", modeToRender);
}}

    modeToRender     Required String with 2D, 3D

Set zoom

dispatch it to change zoom of map.

new HashMap<String, Object>(){{
  put("type", "SET_ZOOM");
  put("zoom", zoom);
  put("zoom_type", zoom_type);
}}

    zoom     Required Number

    zoom_type     Optional String with FLY_TO

Set center

dispatch it to change center of map.

new HashMap<String, Object>(){{
  put("type", "SET_CENTER");
  put("center", Arrays.asList(lng, lat));
}}

    center     Required List of Numbers Default map center in longitude and latitude

Highlight feature

dispatch it to highlight feature.

new HashMap<String, Object>(){{
  put("type", "HIGHLIGHT_FEATURE");
  put("feature_id", feature_id);
}}

    feature_id     Required String with valid feature id

Mark feature

dispatch it to mark feature.

new HashMap<String, Object>(){{
  put("type", "MARK_FEATURE");
  put("feature_id", feature_id);
}}

    feature_id     Required String with valid feature id

Show GPS Button

dispatch it after Map Loaded to show GPS button

new HashMap<String, Object>(){{
  put("type", "ENABLE_GPS_BUTTON");
}}

Don't forget to add permissions to AndroidManifest.xml

<uses-permission android:name="android.permission.ACCESS_GPS" />
<uses-permission android:name="android.permission.ACCESS_ASSISTED_GPS" />
<uses-permission android:name="android.permission.ACCESS_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

** Follow our samples **
https://github.com/tagipedia/tmaps-android-sample/blob/1f109c83e37a6e569e9bef7b71f2ca6190d44636/app/src/main/java/com/tagipedia/tmaps/MainActivity.java#L107-L115
https://github.com/tagipedia/tmaps-android-sample/blob/1f109c83e37a6e569e9bef7b71f2ca6190d44636/app/src/main/java/com/tagipedia/tmaps/MainActivity.java#L134-L200
https://github.com/tagipedia/tmaps-android-sample/blob/1f109c83e37a6e569e9bef7b71f2ca6190d44636/app/src/main/java/com/tagipedia/tmaps/MainActivity.java#L259-L264
https://github.com/tagipedia/tmaps-android-sample/blob/1f109c83e37a6e569e9bef7b71f2ca6190d44636/app/src/main/java/com/tagipedia/tmaps/MainActivity.java#L277-L284
https://github.com/tagipedia/tmaps-android-sample/blob/1f109c83e37a6e569e9bef7b71f2ca6190d44636/app/src/main/java/com/tagipedia/tmaps/MainActivity.java#L304-L344

Start Updating Location using GPS

dispatch it after check location service to start updating user location and showing nearest places to user

new HashMap<String, Object>(){{
  put("type", "START_UPDATING_LOCATION");
  put("is_gps_activated", is_gps_activated);
}}

    is_gps_activated     Required boolean

Show Beacon Location Button

dispatch it after Map Loaded to show Beacon Location button

new HashMap<String, Object>(){{
  put("type", "ENABLE_BEACON_LOCATION_BUTTON");
}}

Start Updating Location using Beacon Location

dispatch it after check beacon location service to start updating user location and showing nearest places to user

new HashMap<String, Object>(){{
  put("type", "START_UPDATING_BEACON_LOCATION");
  put("is_beacon_location_activated", is_beacon_location_activated);
}}

    is_beacon_location_activated     Required boolean

Update User Location (Beacon Location)

dispatch it after beacon location service started to update user location and showing nearest places to user

new HashMap<String, Object>(){{
  put("type", "SET_USER_BEACON_LOCATION");
  put("x", x);
  put("y", y);
  put("origin_lat", origin_lat);
  put("origin_lng", origin_lng);
}}

    x     Required Number
    y     Required Number
    origin_lat     Required Number
    origin_lng     Required Number

Set device data

dispatch it to set device id and device type

new HashMap<String, Object>(){{
  put("type", "SET_DEVICE_DATA");
  put("device_id", device_id);
  put("device_type", "ANDROID");
}}

    device_id     Required String

    device_type     Required String with ANDROID

Set application secrets

dispatch it to set client id and client secret

new HashMap<String, Object>(){{
  put("type", "SET_APPLICATION_SECRETS");
  put("client_id", client_id);
  put("client_secret", client_secret);
}}

    client_id     Required String

    client_secret     Required String

Types

PopupScope

poi

current feature

poi

    poi     Required poi

enableRouting

Boolean to check if routing is enabled

enableRouting

showRoutingDialog

method to show routing dialog.

showRoutingDialog($event, data)

    $event     Required $event

    data     Optional Object with from, to keys and poi value

applyIfneeded

method to call Angular $apply

applyIfneeded(callback)

    callback     Required Function

customData

custom data object that have all keys of template_custom_data

customData[key]

    key     Required with valid key from template_custom_data

dispatch

method to dispatch action from your APP to TMaps.

dispatch(action)

    action     Required Object with valid action

dispatchToContainer

method to dispatch action from TMaps to your APP.

dispatchToContainer(action)

    action     Required Object with type, CUSTOM_KEYS_YOU_NEED keys.
type is String value.
CUSTOM_KEYS_YOU_NEED is any of String, Number, List, Map values.

closeInfo

method to close feature popup

closeInfo()

poi

id

id of feature

poi.id

category

category of feature

poi.category

tags

tags of feature

poi.tags

getTenant

tenant of feature you set in SET_TENANT_DATA

poi.getTenant()

getTenantName

tenant name of feature you set in SET_TENANT_DATA

poi.getTenantName()

getTenantIcon

tenant icon of feature you set in SET_TENANT_DATA

poi.getTenantIcon()

getTenantBoothId

tenant booth_id of feature you set in SET_TENANT_DATA

poi.getTenantBoothId()

getDisplayName

getTenantName or feature name

poi.getDisplayName()

hasName

check if tenant or feature have name.

poi.hasName()

isBuilding

check if feature is building.

poi.isBuilding()

getIcon

getTenantIcon or feature icon

poi.getIcon()

getBoothId

getTenantBoothId or feature booth id

poi.getBoothId()

Advanced Scenrios (Look at sample for implementation of scenrios)

Highlight initial feature

if you dispatch SET_ZOOM/SET_CENTER

you should dispatch HIGHLIGHT_FEATURE for initial feature after ZOOM_ENDED/CENTER_ENDED

if you don't dispatch SET_ZOOM/SET_CENTER

you should dispatch HIGHLIGHT_FEATURE for initial feature after MAP_LOADED

Add custom buttons inside feature popup template

you should dispatch SET_DEFAULT_FEATURE_POPUP_TEMPLATE for your customized template and add your custom buttons and use dispatchToContainer when button clicked to handle the click action in your APP.

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Java 91.6%
  • HTML 8.4%