Class UserInterfaceConfiguration
-
- All Implemented Interfaces:
public class UserInterfaceConfiguration extends ConfigurationSection
-
-
Method Summary
Modifier and Type Method Description int
getAccessibilityAnnouncePeriodInSec()
Get accessibilityAnnouncePeriodInSec. String
getAccuracyCircleStaticColor()
Get accuracyCircleStaticColor. String
getAccuracyCircleStaticColour()
Get accuracyCircleStaticColour. String
getAppLogoUrl()
Get appLogoUrl. int
getCategorySymbolFrame()
Get categorySymbolFrame. float
getDefaultLocationZoomLevel()
Get defaultLocationZoomLevel. float
getDefaultOutdoorLocationZoomLevel()
Get defaultOutdoorLocationZoomLevel. boolean
getDisableScreenDimDuringWayfinding()
Get disableScreenDimDuringWayfinding. float
getDisconnectedIndoorPathDistanceThresholdInMeters()
Get disconnectedIndoorPathDistanceThresholdInMeters. float
getDisconnectedOutdoorPathDistanceThresholdInMeters()
Get disconnectedOutdoorPathDistanceThresholdInMeters. int
getDistanceUnit()
Get distanceUnit. boolean
getEnableDynamicMinimumZoomLevel()
Get enableDynamicMinimumZoomLevel. float
getFlyOverAnimationDuration()
Get flyOverAnimationDuration. float
getFlyOverAnimationHeading()
Get flyOverAnimationHeading. float
getFlyOverTiltAngleInDegrees()
Get flyOverTiltAngleInDegrees. String
getInfoPageUrl()
Get infoPageUrl. boolean
getIsCategorySymbolThemeEnabled()
Get isCategorySymbolThemeEnabled. boolean
getIsInfoButtonEnabled()
Get isInfoButtonEnabled. boolean
getIsMarkMyCarEnabled()
Get isMarkMyCarEnabled. boolean
getIsNavigationHeaderThemeAccentColor()
Get isNavigationHeaderThemeAccentColor. boolean
getIsOfflineMapsEnabled()
Get isOfflineMapsEnabled. boolean
getIsOnboardingEnabled()
Get isOnboardingEnabled. boolean
getIsRatingPopupEnabled()
Get isRatingPopupEnabled. boolean
getIsSearchCategoriesEnabled()
Get isSearchCategoriesEnabled. boolean
getIsSplashScreenEnabled()
Get isSplashScreenEnabled. int
getMapWidgetLocationDataTimeoutInSeconds()
Get mapWidgetLocationDataTimeoutInSeconds. int
getMapWidgetMapTilesTimeoutInSeconds()
Get mapWidgetMapTilesTimeoutInSeconds. int
getMapWidgetMapUrlTimeoutInSeconds()
Get mapWidgetMapUrlTimeoutInSeconds. int
getMapWidgetPathDataTimeoutInSeconds()
Get mapWidgetPathDataTimeoutInSeconds. int
getMapWidgetPoiDataTimeoutInSeconds()
Get mapWidgetPoiDataTimeoutInSeconds. int
getMapWidgetSiteDataTimeoutInSeconds()
Get mapWidgetSiteDataTimeoutInSeconds. float
getMaxZoomScale()
Get maxZoomScale. float
getMaximumZoomLevel()
Get maximumZoomLevel. float
getMinZoomScale()
Get minZoomScale. float
getMinimumZoomLevel()
Get minimumZoomLevel. String
getPathColor()
Get pathColor. float
getPathDirectionThresholdInMeters()
Get pathDirectionThresholdInMeters. float
getPathTrackingTiltAngleInDegrees()
Get pathTrackingTiltAngleInDegrees. float
getPathWidth()
Get pathWidth. String
getPrivacyPolicyUrl()
Get privacyPolicyUrl. float
getQuickAccessTiltAngleInDegrees()
Get quickAccessTiltAngleInDegrees. float
getRotationalTrackingCameraAngleThreshold()
Get rotationalTrackingCameraAngleThreshold. boolean
getShouldFocusOnFirstUserLocation()
Get shouldFocusOnFirstUserLocation. String
getSupportEmail()
Get supportEmail. String
getTermsAndConditionsUrl()
Get termsAndConditionsUrl. float
getTurnBackAngleThresholdInDegrees()
Get turnBackAngleThresholdInDegrees. -
-
Method Detail
-
getAccessibilityAnnouncePeriodInSec
int getAccessibilityAnnouncePeriodInSec()
Get accessibilityAnnouncePeriodInSec. Duration in seconds to repeat the same announcements, in accessibility mode. Default is 10
- Returns:
accessibilityAnnouncePeriodInSec value
-
getAccuracyCircleStaticColor
@NonNull() String getAccuracyCircleStaticColor()
Get accuracyCircleStaticColor. The color used for the accuracy circle drawn around the user pin in HEX Default is "007AFF"
- Returns:
accuracyCircleStaticColor value
-
getAccuracyCircleStaticColour
@NonNull() String getAccuracyCircleStaticColour()
Get accuracyCircleStaticColour. The color used for the accuracy circle drawn around the user pin in HEX Default is "007AFF"
- Returns:
accuracyCircleStaticColour value
-
getAppLogoUrl
@NonNull() String getAppLogoUrl()
Get appLogoUrl. App Logo URL Default is ""
- Returns:
appLogoUrl value
-
getCategorySymbolFrame
int getCategorySymbolFrame()
Get categorySymbolFrame. What frame to use behind category symbols none (0), circle (1), rounded (2), square (3) Default is 2
- Returns:
categorySymbolFrame value
-
getDefaultLocationZoomLevel
float getDefaultLocationZoomLevel()
Get defaultLocationZoomLevel. Default zoom level to use while focusing to any location. Default is 18.0
- Returns:
defaultLocationZoomLevel value
-
getDefaultOutdoorLocationZoomLevel
float getDefaultOutdoorLocationZoomLevel()
Get defaultOutdoorLocationZoomLevel. The default zoom level for outdoors Default is 18.0
- Returns:
defaultOutdoorLocationZoomLevel value
-
getDisableScreenDimDuringWayfinding
boolean getDisableScreenDimDuringWayfinding()
Get disableScreenDimDuringWayfinding. If whether the screen should not be dimmed during wayfinding. Default is true
- Returns:
disableScreenDimDuringWayfinding value
-
getDisconnectedIndoorPathDistanceThresholdInMeters
float getDisconnectedIndoorPathDistanceThresholdInMeters()
Get disconnectedIndoorPathDistanceThresholdInMeters. Default is 11.0
- Returns:
disconnectedIndoorPathDistanceThresholdInMeters value
-
getDisconnectedOutdoorPathDistanceThresholdInMeters
float getDisconnectedOutdoorPathDistanceThresholdInMeters()
Get disconnectedOutdoorPathDistanceThresholdInMeters. Default is 21.0
- Returns:
disconnectedOutdoorPathDistanceThresholdInMeters value
-
getDistanceUnit
int getDistanceUnit()
Get distanceUnit. What type of units should be used for distance in the UI Default is 0
- Returns:
distanceUnit value
-
getEnableDynamicMinimumZoomLevel
boolean getEnableDynamicMinimumZoomLevel()
Get enableDynamicMinimumZoomLevel. If set true, minimumZoomLevel is dynamically calculated to a value enough to see the whole site Default is true
- Returns:
enableDynamicMinimumZoomLevel value
-
getFlyOverAnimationDuration
float getFlyOverAnimationDuration()
Get flyOverAnimationDuration. Duration in seconds it takes to do the loading fly over animation. Default is 3.0
- Returns:
flyOverAnimationDuration value
-
getFlyOverAnimationHeading
float getFlyOverAnimationHeading()
Get flyOverAnimationHeading. Heading of the map at the end of the fy over animation. Default is 0.0
- Returns:
flyOverAnimationHeading value
-
getFlyOverTiltAngleInDegrees
float getFlyOverTiltAngleInDegrees()
Get flyOverTiltAngleInDegrees. Default is 45.0
- Returns:
flyOverTiltAngleInDegrees value
-
getInfoPageUrl
@NonNull() String getInfoPageUrl()
Get infoPageUrl. Info Page URL Default is "https://pointr-websdk.azureedge.net/ui-configuration/web-sdk-v8/info-page/info-page.html"
- Returns:
infoPageUrl value
-
getIsCategorySymbolThemeEnabled
boolean getIsCategorySymbolThemeEnabled()
Get isCategorySymbolThemeEnabled. Whether the category symbols are affected by the theme. Default is true
- Returns:
isCategorySymbolThemeEnabled value
-
getIsInfoButtonEnabled
boolean getIsInfoButtonEnabled()
Get isInfoButtonEnabled. Whether to enable the info button or not Default is true
- Returns:
isInfoButtonEnabled value
-
getIsMarkMyCarEnabled
boolean getIsMarkMyCarEnabled()
Get isMarkMyCarEnabled. Whether mark my car feature is enabled. Default is true
- Returns:
isMarkMyCarEnabled value
-
getIsNavigationHeaderThemeAccentColor
boolean getIsNavigationHeaderThemeAccentColor()
Get isNavigationHeaderThemeAccentColor. If whether the navigation header color is accent color from theme. Default is true
- Returns:
isNavigationHeaderThemeAccentColor value
-
getIsOfflineMapsEnabled
boolean getIsOfflineMapsEnabled()
Get isOfflineMapsEnabled. Enable/Disable offline maps feature Default is true
- Returns:
isOfflineMapsEnabled value
-
getIsOnboardingEnabled
boolean getIsOnboardingEnabled()
Get isOnboardingEnabled. Whether to enable onboarding or not Default is true
- Returns:
isOnboardingEnabled value
-
getIsRatingPopupEnabled
boolean getIsRatingPopupEnabled()
Get isRatingPopupEnabled. Whether the rate experience pop-up is enabled. Analytics also need to be enabled. Default is true
- Returns:
isRatingPopupEnabled value
-
getIsSearchCategoriesEnabled
boolean getIsSearchCategoriesEnabled()
Get isSearchCategoriesEnabled. If whether the categories search UI is enabled. Default is true
- Returns:
isSearchCategoriesEnabled value
-
getIsSplashScreenEnabled
boolean getIsSplashScreenEnabled()
Get isSplashScreenEnabled. Whether to enable the splash screen or not Default is false
- Returns:
isSplashScreenEnabled value
-
getMapWidgetLocationDataTimeoutInSeconds
int getMapWidgetLocationDataTimeoutInSeconds()
Get mapWidgetLocationDataTimeoutInSeconds. After how much time map widget will timeout waiting for location data (seconds). Default is 20
- Returns:
mapWidgetLocationDataTimeoutInSeconds value
-
getMapWidgetMapTilesTimeoutInSeconds
int getMapWidgetMapTilesTimeoutInSeconds()
Get mapWidgetMapTilesTimeoutInSeconds. After how much time map widget will timeout waiting for map tiles (seconds). Default is 30
- Returns:
mapWidgetMapTilesTimeoutInSeconds value
-
getMapWidgetMapUrlTimeoutInSeconds
int getMapWidgetMapUrlTimeoutInSeconds()
Get mapWidgetMapUrlTimeoutInSeconds. After how much time map widget will timeout waiting for map url (seconds). Default is 30
- Returns:
mapWidgetMapUrlTimeoutInSeconds value
-
getMapWidgetPathDataTimeoutInSeconds
int getMapWidgetPathDataTimeoutInSeconds()
Get mapWidgetPathDataTimeoutInSeconds. After how much time map widget will timeout waiting for path data (seconds). Default is 30
- Returns:
mapWidgetPathDataTimeoutInSeconds value
-
getMapWidgetPoiDataTimeoutInSeconds
int getMapWidgetPoiDataTimeoutInSeconds()
Get mapWidgetPoiDataTimeoutInSeconds. After how much time map widget will timeout waiting for poi data (seconds). Default is 30
- Returns:
mapWidgetPoiDataTimeoutInSeconds value
-
getMapWidgetSiteDataTimeoutInSeconds
int getMapWidgetSiteDataTimeoutInSeconds()
Get mapWidgetSiteDataTimeoutInSeconds. After how much time map widget will timeout waiting for site data (seconds). Default is 60
- Returns:
mapWidgetSiteDataTimeoutInSeconds value
-
getMaxZoomScale
float getMaxZoomScale()
Get maxZoomScale. Maximum zoom level allowed for the map Default is 18.5
- Returns:
maxZoomScale value
-
getMaximumZoomLevel
float getMaximumZoomLevel()
Get maximumZoomLevel. Maximum zoom level allowed for the map Default is 18.5
- Returns:
maximumZoomLevel value
-
getMinZoomScale
float getMinZoomScale()
Get minZoomScale. Minimum zoom level allowed for the map Default is 16.0
- Returns:
minZoomScale value
-
getMinimumZoomLevel
float getMinimumZoomLevel()
Get minimumZoomLevel. Minimum zoom level allowed for the map Default is 16.0
- Returns:
minimumZoomLevel value
-
getPathColor
@NonNull() String getPathColor()
Get pathColor. The color of the displayed path in HEX format Default is "0080FF"
- Returns:
pathColor value
-
getPathDirectionThresholdInMeters
float getPathDirectionThresholdInMeters()
Get pathDirectionThresholdInMeters. Distance left to the next path direction, before we stop showing remaining Default is 5.0
- Returns:
pathDirectionThresholdInMeters value
-
getPathTrackingTiltAngleInDegrees
float getPathTrackingTiltAngleInDegrees()
Get pathTrackingTiltAngleInDegrees. Default is 45.0
- Returns:
pathTrackingTiltAngleInDegrees value
-
getPathWidth
float getPathWidth()
Get pathWidth. The width of the displayed path in points Default is 8.0
- Returns:
pathWidth value
-
getPrivacyPolicyUrl
@NonNull() String getPrivacyPolicyUrl()
Get privacyPolicyUrl. Privacy Policy URL Default is "https://www.pointr.tech/technology/privacy-and-security"
- Returns:
privacyPolicyUrl value
-
getQuickAccessTiltAngleInDegrees
float getQuickAccessTiltAngleInDegrees()
Get quickAccessTiltAngleInDegrees. Default is 45.0
- Returns:
quickAccessTiltAngleInDegrees value
-
getRotationalTrackingCameraAngleThreshold
float getRotationalTrackingCameraAngleThreshold()
Get rotationalTrackingCameraAngleThreshold. How much the blue dot heading needs to change in order for the camera to rotate. Default is 10.0
- Returns:
rotationalTrackingCameraAngleThreshold value
-
getShouldFocusOnFirstUserLocation
boolean getShouldFocusOnFirstUserLocation()
Get shouldFocusOnFirstUserLocation. If this parameter is true, then the map will focus on the user location when it first becomes available even if the user is browsing a different building Default is true
- Returns:
shouldFocusOnFirstUserLocation value
-
getSupportEmail
@NonNull() String getSupportEmail()
Get supportEmail. Support Email Default is "support@pointr.tech"
- Returns:
supportEmail value
-
getTermsAndConditionsUrl
@NonNull() String getTermsAndConditionsUrl()
Get termsAndConditionsUrl. Terms and Conditions URL Default is "https://www.pointr.tech/end-user-agreement"
- Returns:
termsAndConditionsUrl value
-
getTurnBackAngleThresholdInDegrees
float getTurnBackAngleThresholdInDegrees()
Get turnBackAngleThresholdInDegrees. Default is 120.0
- Returns:
turnBackAngleThresholdInDegrees value
-
-
-
-