Skip to main content

Livemap

Livemap

Type: public class

This class represents a Livemap and allows the developer to interact with it.

centerTo(@NonNull Coordinates coordinates, double zoom)

Type: public void

Center the map on the given position and set the zoom.

Parameter NameTypeDescription
coordinates@NonNullcoordinates
zoomdoublenew zoom level

openEvent(int eventId)

Type: public void

Open an event on the map. This can only be used for maps which use events.

Parameter NameTypeDescription
eventIdinteid Event ID

openPinpoint(int pinpointId)

Type: public void

Open a pinpoint on the map.

Parameter NameTypeDescription
pinpointIdintid of the pinpoint to open

closeEvent()

Type: public void

Close the current opened event. Go to the search view.

closePinpoint()

Type: public void

Close the current opened pinpoint. Go to the search view.

openList(int listId)

Type: public void

Open a list on the map.

Parameter NameTypeDescription
listIdintthe list id

closeList()

Type: public void

Close the current opened list. Go to the search view.

closePopin()

Type: public void

Close the current opened popin.

setFilters(@NonNull Filters filters)

Type: public void

Update search filters (dates, tags, text).

Parameter NameTypeDescription
filters@NonNullfilters to set

Type: public void

Start navigation to a pinpoint. The navigation will start with the user location.

Parameter NameTypeDescription
pinpointIdintid of the destination pinpoint.

Type: @Deprecated public void

Start navigation to a pinpoint. Can be an absolute navigation (start location based on phone sensors) or a relative navigation (given start location & heading). If start location and initialHeading are not provided, the navigation will start with the user location.

Parameter NameTypeDescription
pinpointIdintid of the destination pinpoint.
startLocation@NonNullFor relative navigation only. Navigation start location
startHeadingintFor relative navigation only. Navigation start heading (in degrees).

stopNavigation()

Type: public void

Stop the currently running navigation.

signInByToken(@NonNull String accessToken)

Type: public void

Sign in to UFE with wemap JWT token.

Parameter NameTypeDescription
accessToken@NonNullthe JWT access token.

enableSidebar()

Type: public void

Activate the bar with several rows of content (of events, pinpoints, list, etc).

disableSidebar()

Type: public void

Deactivate the bar with several rows of content (of events, pinpoints, list, etc).

signOut()

Type: public void

Sign out the current user.

setSourceLists(@NonNull List <Integer > sourceLists)

Type: public void

Define one or more lists to be displayed on the map in addition of the current pinpoints of the map.

Parameter NameTypeDescription
sourceLists@NonNullThe id of the lists

setPinpoints(@NonNull List <Pinpoint > pinpoints)

Type: public void

Populates the map with given pinpoints.

Parameter NameTypeDescription
pinpoints@NonNullPinpoints to populate the map.

setPinpoints(@NonNull List <Pinpoint > pinpoints, @Nullable SetPinpointsCallback callback)

Type: public void

Populates the map with given pinpoints.

Parameter NameTypeDescription
pinpoints@NonNullPinpoints to populate the map.
callback@Nullablethe callback

setPinpoints(@NonNull List <Pinpoint > pinpoints, String type)

Type: public void

Populates the map with given pinpoints.

Parameter NameTypeDescription
pinpoints@NonNullPinpoints to populate the map.
typeStringthe type of how the map is populated (replace or add)

setPinpoints(@NonNull List <Pinpoint > pinpoints, @NonNull String type, @Nullable SetPinpointsCallback callback)

Type: public void

Populates the map with given pinpoints.

Parameter NameTypeDescription
pinpoints@NonNullPinpoints to populate the map.
type@NonNullthe type of how the map is populated (replace or add)
callback@Nullablethe callback

setEvents(@NonNull List <Event > events)

Type: public void

Populates the map with given events.

Parameter NameTypeDescription
events@NonNullEvents to populate the map.

setEvents(@NonNull List <Event > events, @Nullable SetEventsCallback callback)

Type: public void

Populates the map with given events.

Parameter NameTypeDescription
events@NonNullEvents to populate the map.
callback@Nullablethe callback

aroundMe()

Type: public void

Center the map on the user's location.

enableAnalytics()

Type: public void

Enable analytics tracking

disableAnalytics()

Type: public void

Disable analytics tracking

addPinpointOpenListener(@NonNull PinpointOpenListener listener)

Type: public void

Register a listener for the event onPinpointOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removePinpointOpenListener(@NonNull PinpointOpenListener listener)

Type: public void

Remove a listener for the event onPinpointOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addPinpointCloseListener(@NonNull PinpointCloseListener listener)

Type: public void

Register a listener for the event onPinpointClose.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removePinpointCloseListener(@NonNull PinpointCloseListener listener)

Type: public void

Remove a listener for the event onPinpointClose.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addMultipointOpenListener(@NonNull MultipointOpenListener listener)

Type: public void

Register a listener for the event onMultipointOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeMultipointOpenListener(@NonNull MultipointOpenListener listener)

Type: public void

Remove a listener for the event onMultipointOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addMultipointCloseListener(@NonNull MultipointCloseListener listener)

Type: public void

Register a listener for the event onMultipointClose.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeMultipointCloseListener(@NonNull MultipointCloseListener listener)

Type: public void

Remove a listener for the event onMultipointClose.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addEventOpenListener(@NonNull EventOpenListener listener)

Type: public void

Register a listener for the event onEventOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeEventOpenListener(@NonNull EventOpenListener listener)

Type: public void

Remove a listener for the event onEventOpen.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addEventCloseListener(@NonNull EventCloseListener listener)

Type: public void

Register a listener for the event onEventClose.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeEventCloseListener(@NonNull EventCloseListener listener)

Type: public void

Remove a listener for the event onEventClose.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addGuidingStartedListener(@NonNull GuidingStartedListener listener)

Type: public void

Register a listener for the event onGuidingStarted.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeGuidingStartedListener(@NonNull GuidingStartedListener listener)

Type: public void

Remove a listener for the event onGuidingStarted.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addGuidingUpdatedListener(@NonNull GuidingUpdatedListener listener)

Type: public void

Register a listener for the event onGuidingUpdated.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeGuidingUpdatedListener(@NonNull GuidingUpdatedListener listener)

Type: public void

Remove a listener for the event onGuidingUpdated.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addGuidingStoppedListener(@NonNull GuidingStoppedListener listener)

Type: public void

Register a listener for the event onGuidingStopped.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeGuidingStoppedListener(@NonNull GuidingStoppedListener listener)

Type: public void

Remove a listener for the event onGuidingStopped.

Parameter NameTypeDescription
listener@NonNullthe listener to remove

addUserLoginListener(@NonNull UserLoginListener listener)

Type: public void

Register a listener for the event onUserLogin.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeUserLoginListener(@NonNull UserLoginListener listener)

Type: public void

Remove a listener for the event onUserLogin.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addUserLogoutListener(@NonNull UserLogoutListener listener)

Type: public void

Register a listener for the event onUserLogout.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeUserLogoutListener(@NonNull UserLogoutListener listener)

Type: public void

Remove a listener for the event onUserLogout.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addMapClickListener(@NonNull MapClickListener listener)

Type: public void

Register a listener for the event mapClick.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeMapClickListener(@NonNull MapClickListener listener)

Type: public void

Remove a listener for the event mapClick.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addMapLongClickListener(@NonNull MapLongClickListener listener)

Type: public void

Register a listener for the event mapLongCLick.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeMapLongListener(@NonNull MapLongClickListener listener)

Type: public void

Remove a listener for the event mapLongCLick.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addMapMovedListener(@NonNull MapMovedListener listener)

Type: public void

Register a listener for the event mapMoved.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeMapMovedListener(@NonNull MapMovedListener listener)

Type: public void

Remove a listener for the event mapMoved.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addActionButtonClickedListener(@NonNull ActionButtonClickListener listener)

Type: public void

Register a listener for the events of action buttons.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeActionButtonClickedListener(@NonNull ActionButtonClickListener listener)

Type: public void

Remove a listener for the events of action buttons.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addContentUpdatedListener(@NonNull ContentUpdatedListener listener)

Type: public void

Register a listener for the events of contents updated.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeContentUpdatedListener(@NonNull ContentUpdatedListener listener)

Type: public void

Remove a listener for the events of contents updated.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addFullscreenEnterListener(@NonNull FullscreenEnterListener listener)

Type: public void

Register a listener for the fullscreen enter events.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeFullscreenEnterListener(@NonNull FullscreenEnterListener listener)

Type: public void

Remove a listener for the the fullscreen enter events.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addFullscreenExitListener(@NonNull FullscreenExitListener listener)

Type: public void

Register a listener for the fullscreen exit events.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeFullscreenExitListener(@NonNull FullscreenExitListener listener)

Type: public void

Remove a listener for the the fullscreen exit events.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addListOpenListener(@NonNull ListOpenListener listener)

Type: public void

Register a listener for the list open events.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeListOpenListener(@NonNull ListOpenListener listener)

Type: public void

Remove a listener for the the list open events.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

addListCloseListener(@NonNull ListCloseListener listener)

Type: public void

Register a listener for the list close events.

Parameter NameTypeDescription
listener@NonNullthe listener to register.

removeListCloseListener(@NonNull ListCloseListener listener)

Type: public void

Remove a listener for the the list close events.

Parameter NameTypeDescription
listener@NonNullthe listener to remove.

drawPolyline(@NonNull List <Coordinates > coordinates, @Nullable PolylineOptions options, @Nullable DrawPolylineCallback callback)

Type: public void

Draw a polyline.

Parameter NameTypeDescription
coordinates@NonNullcoordinates of the polyline
options@Nullablethe polyline options
callback@Nullablethe callback of polyline creation

drawPolyline(@NonNull List <Coordinates > coordinates, @Nullable PolylineOptions options)

Type: public void

Draw a polyline.

Parameter NameTypeDescription
coordinates@NonNullcoordinates of the polyline
options@Nullablethe polyline options

drawPolyline(@NonNull List <Coordinates > coordinates)

Type: public void

Draw a polyline.

Parameter NameTypeDescription
coordinates@NonNullcoordinates of the polyline

removePolyline(@NonNull String polylineId)

Type: public void

Remove a previously drawn polyline

Parameter NameTypeDescription
polylineId@NonNullthe polyline id sent by the PolylineDrawCallback during the creation

addMarker(@NonNull Marker marker, @Nullable AddMarkerCallback callback)

Type: public void

Add marker to the map.

Parameter NameTypeDescription
marker@NonNullthe marker to add
callback@Nullablethe callback of marker creation

addMarker(@NonNull Marker marker)

Type: public void

Add marker to the map.

Parameter NameTypeDescription
marker@NonNullthe marker to add

removeMarker(@NonNull String markerId)

Type: public void

Remove a previously drawn marker

Parameter NameTypeDescription
markerId@NonNullthe marker id sent by the AddMarkerCallback during the creation

findNearestPinpoints(@NonNull Coordinates center, @NonNull FindNearestPinpointsCallback callback)

Type: public void

Find the nearest pinpoints from a point.

Parameter NameTypeDescription
center@NonNullcenter for the search.
callback@NonNullthe callback

getCenter(@NonNull GetCenterCallback callback)

Type: public void

Return the map's geographical center.

Parameter NameTypeDescription
callback@NonNullthe map center

getZoom(@NonNull GetZoomCallback callback)

Type: public void

Return the map's zoom level.

Parameter NameTypeDescription
callback@NonNullthe map's zoom level

setCenter(@NonNull Coordinates center)

Type: public void

Set the map's geographical center.

Parameter NameTypeDescription
center@NonNullthe new map's center

setZoom(float zoomLevel)

Type: public void

Set the map's zoom level.

Parameter NameTypeDescription
zoomLevelfloatthe new map's zoom level

setBearing(float bearing)

Type: public void

Set the map's bearing. Note: default duration is 500ms

Parameter NameTypeDescription
bearingfloatthe new map's bearing (in degrees)

setBearing(float bearing, float duration)

Type: public void

Set the map's bearing.

Parameter NameTypeDescription
bearingfloatthe new map's bearing (in degrees)
durationfloatduration of animation in ms

fitBounds(@NonNull BoundingBox boundingBox, @Nullable FitBoundsOptions options)

Type: public void

Fit the map on given bounds.

Parameter NameTypeDescription
boundingBox@NonNullCoordinates bounds to fit on.
options@NullableOptions for the action.

fitBounds(@NonNull BoundingBox boundingBox)

Type: public void

Fit the map on given bounds.

Parameter NameTypeDescription
boundingBox@NonNullCoordinates bounds to fit on.

disablePositioningSystem()

Type: public void

Disable the internal positioning system (user location and attitude). Please use setUserLocation and setDeviceAttitude to provide a position and an attitude to the livemap. This information will enable (1) the use of the blue dot on the map and (2) the use of Geo Augmented Reality

getUserLocation(@NonNull GetUserLocationCallback callback)

Type: public void

Return user location.

Parameter NameTypeDescription
callback@NonNullthe user location

setUserLocation(@NonNull UserLocation userLocation)

Type: public void

Set the user location.

Parameter NameTypeDescription
userLocation@NonNullthe user location

getDeviceAttitude(@NonNull GetDeviceAttitudeCallback callback)

Type: public void

Return the device attitude in ENU coordinates system.

Parameter NameTypeDescription
callback@NonNullthe user location

setDeviceAttitude(@NonNull Attitude attitude)

Type: public void

Set the device attitude in ENU coordinates system.

Parameter NameTypeDescription
attitude@NonNullthe device attitude in ENU coordinates system