Package es.situm.wayfinding

Class LibrarySettings

  • public class LibrarySettings
extends Object
    Situm Maps initialization settings.

    • Constructor Detail

      • LibrarySettings

        public LibrarySettings()

    • Method Detail

      • setUseDashboardTheme

        public void setUseDashboardTheme​(boolean useDashboardTheme)
        Use the theme defined in the dashboard.
        Parameters:
        useDashboardTheme - Whether the dashboard vs default theme should be used.

      • setDrawGeofences

        public void setDrawGeofences​(boolean drawGeofences)
        Draw the geofences over the map.

      • getCredentials

        @Nullable
public es.situm.maps.library.domain.model.Credentials getCredentials()
        Get login credentials.
        Returns:
        Login credentials or null if none were provided.

      • setApiKey

        public void setApiKey​(@NonNull
                      String email,
                      @NonNull
                      String apiKey)
        Set dashboard credentials.
        Parameters:
        email - Email.
        apiKey - ApiKey.

      • setUserPass

        public void setUserPass​(@NonNull
                        String email,
                        @NonNull
                        String password)
        Set dashboard credentials.
        Parameters:
        email - Email.
        password - Password.

      • setDashboardUrl

        public void setDashboardUrl​(@NonNull
                            String dashboardUrl)
        Overrides default dashboard URL.
        Parameters:
        dashboardUrl - Dashboard URL.

      • setHasSearchView

        public void setHasSearchView​(boolean hasSearchView)
        Set whether or not the search view should be displayed.
        Parameters:
        hasSearchView - true to display the search view component.

      • setSearchViewPlaceholder

        public void setSearchViewPlaceholder​(String placeholder)
        Set the text that will be used as placeholder in the search view component.
        Parameters:
        placeholder - Placeholder text.

      • setGoogleMap

        public void setGoogleMap​(@NonNull
                         com.google.android.gms.maps.MapView googleMap)
        By default the library will create a Google Map itself, use this method to set your own one.
        Parameters:
        googleMap - Google Map view instance

      • getInitialZoom

        public int getInitialZoom()
        Get the initial zoom that will be set to the MapView
        Returns:
        initialZoom

      • setInitialZoom

        public void setInitialZoom​(int initialZoom)
        Initial zoom that will be set once you select a building. Take in consideration that the max value of GoogleMap's zoom allowed is 21, so any value above it will be ignored. Also the minimum value is set to 15, so any value below it is ignored as well.
        Parameters:
        initialZoom - Initial zoom preference.

      • getMinZoom

        public int getMinZoom()

      • setMinZoom

        public void setMinZoom​(int minZoomLevel)
        Min zoom that will be set on the underlying map. This method inherits all the technical considerations that applies to the underlying map (see GoogleMap#setMaxZoomPreference(float z)).
        Parameters:
        minZoomLevel - Min zoom preference.

      • getMaxZoom

        public int getMaxZoom()

      • setMaxZoom

        public void setMaxZoom​(int maxZoomLevel)
        Min zoom that will be set on the underlying map. This value cannot be lower than the minimum supported by setInitialZoom(int). This method inherits all the technical considerations that applies to the underlying map (see GoogleMap#setMinZoomPreference(float z)).
        Parameters:
        maxZoomLevel - Max zoom preference.
        See Also:
        setInitialZoom(int)

      • getUserPositionIcon

        public String getUserPositionIcon()
        Get the icon representing the user position.
        Returns:
        Path of the icon in the assets folder.

      • setUserPositionIcon

        public void setUserPositionIcon​(String userPositionIcon)
        Set the icon representing the user position.
        Parameters:
        userPositionIcon - Path in the assets folder.

      • getUserPositionArrowIcon

        public String getUserPositionArrowIcon()
        Get the icon representing the user position with orientation.
        Returns:
        Path of the icon in the assets folder.

      • setUserPositionArrowIcon

        public void setUserPositionArrowIcon​(String userPositionArrowIcon)
        Set the icon representing the user position with orientation.
        Parameters:
        userPositionArrowIcon - Path in the assets folder.

      • isUseRemoteConfig

        public boolean isUseRemoteConfig()
        Returns whether or not to use the Remote Configuration when the positioning is started.
        Returns:
        true to use Remote Config, false to use the default location settings. Default value is true.

      • setUseRemoteConfig

        public void setUseRemoteConfig​(boolean useRemoteConfig)
        Set whether or not to use the Remote Configuration when the positioning is started. The default value is true. Both default and remote config can be overridden using the provided interceptor.
        Parameters:
        useRemoteConfig - true to use Remote Config, false to use the default location settings.
        See Also:
        SitumMapsLibrary#addLocationRequestInterceptor(Interceptor)

      • isShowPoiNames

        public boolean isShowPoiNames()
        Shows the title of the poi above the marker
        Returns:
        Return true if it should show the title of the poi above the marker. Default is true

      • setShowPoiNames

        public void setShowPoiNames​(boolean showPoiNames)
        Shows the title of the poi above the marker
        Parameters:
        showPoiNames - True to show the title of the poi above the marker

      • useExternalLocations

        public void useExternalLocations​(boolean useExternalLocations)
        Configures the SDK to use external locations instead of calculating indoor positions.
        Parameters:
        useExternalLocations - True to use external location. SDK will not calculate indoor position.

      • isUseExternalLocations

        public boolean isUseExternalLocations()
        Allows the SDK to use other locations different from Situm's indoor position.
        Returns:
        true if SDK should not calculate indoor positioning and instead rely on external locations.

      • setEnablePoiClustering

        public void setEnablePoiClustering​(boolean enablePoiClustering)
        Sets whether or not the marker clustering for POIs is enabled.
        Parameters:
        enablePoiClustering - true to enable clustering, false to disable it. Default is true.

      • isEnablePoiClustering

        public boolean isEnablePoiClustering()
        Returns whether or not the marker clustering for POIs is enabled. Default is true.
        Returns:
        true to enable clustering, false to disable it.

      • setShowNavigationIndications

        public void setShowNavigationIndications​(boolean showNavigationIndications)
        Enable or disable navigation indications.
        Parameters:
        showNavigationIndications - true to enable these indications, false to disable them. Default is true.

      • isShowNavigationIndications

        public boolean isShowNavigationIndications()
        Returns whether or not indications while navigating are enabled.
        Returns:
        true to enable navigation indications, false to disable them. Default is true.