Class default

constructor

• new default(): default

  Returns default

StaticnavigationIsRunning

StaticpositioningIsRunning

StaticcheckIfPointInsideGeofence

• checkIfPointInsideGeofence(
      request: any,
      callback?: (response: { geofence: any; isInsideGeofence: boolean }) => void,
  ): void

  Checks if a point is inside a Geofence

  Parameters

  • request: any
  • Optionalcallback: (response: { geofence: any; isInsideGeofence: boolean }) => void

  Returns void

StaticconfigureUserHelper

• configureUserHelper(userHelperOptions: UserHelperOptions): undefined | void

  Automatically assists users in resolving app-related permission and sensor issues.

  This method tells the native SDKs to present a user interface that explains detected configuration issues and guides users through the required steps to resolve them, following best practices for runtime permission requests.

  Issues addressed include:

  • Missing permissions for Location or Bluetooth.
  • Disabled Location or Bluetooth sensors.

  Use the userHelperOptions parameter to configure the available options. Call enableUserHelper as a shortcut to enable the user helper with default configuration. Call disableUserHelper as a shortcut to disable the user helper.

  Parameters

  • userHelperOptions: UserHelperOptions

    Options for the user helper.

  Returns undefined | void

StaticdisableUserHelper

• disableUserHelper(): void

  Disables the user helper.

  Shortcut for configureUserHelper with {enabled: false}.

  Returns void

StaticenableUserHelper

• enableUserHelper(): void

  Enables the user helper.

  Shortcut for configureUserHelper with {enabled: true}.

  Returns void

StaticfetchBuildingInfo

• fetchBuildingInfo(building: Building): Promise<BuildingInfo>

  Downloads all the building data for the selected building. This info includes Floor, indoor and outdoor Pois, events and paths. Also it download floor maps and PoiCategory icons to local storage.

  Parameters

  • building: Building

    Building

  Returns Promise<BuildingInfo>

StaticfetchBuildings

• fetchBuildings(): Promise<Building[]>

  Downloads all the Buildings for the current user.

  Returns Promise<Building[]>

StaticfetchFloorsFromBuilding

• fetchFloorsFromBuilding(building: Building): Promise<Floor[]>

  Downloads all the floors of a building

  Parameters

  • building: Building

    Building

  Returns Promise<Floor[]>

StaticfetchGeofencesFromBuilding

• fetchGeofencesFromBuilding(building: Building): Promise<Geofence[]>

  Get the geofences of a Building

  Parameters

  • building: Building

    Building

  Returns Promise<Geofence[]>

StaticfetchIndoorPOIsFromBuilding

• fetchIndoorPOIsFromBuilding(building: Building): Promise<Poi[]>

  Download the indoor Pois of a Building

  Parameters

  • building: Building

    Building

  Returns Promise<Poi[]>

StaticfetchMapFromFloor

• fetchMapFromFloor(floor: Floor): Promise<string>

  Downloads the map image of a Floor

  Parameters

  • floor: Floor

    Floor

  Returns Promise<string>

StaticfetchOutdoorPOIsFromBuilding

• fetchOutdoorPOIsFromBuilding(building: Building): Promise<Poi[]>

  Download the outdoor Pois of a Building

  Parameters

  • building: Building

    Building

  Returns Promise<Poi[]>

StaticfetchPoiCategories

• fetchPoiCategories(): Promise<PoiCategory[]>

  Get all PoiCategory, download and cache their icons asynchronously.

  Returns Promise<PoiCategory[]>

StaticfetchPoiCategoryIconNormal

• fetchPoiCategoryIconNormal(category: PoiCategory): Promise<PoiIcon>

  Get the normal PoiIcon for a category

  Parameters

  • category: PoiCategory

    PoiCategory. Not null.

  Returns Promise<PoiIcon>

StaticfetchPoiCategoryIconSelected

• fetchPoiCategoryIconSelected(category: PoiCategory): Promise<PoiIcon>

  Get the selected PoiIcon for a PoiCategory

  Parameters

  • category: PoiCategory

    PoiCategory. Not null.

  Returns Promise<PoiIcon>

StaticfetchTilesFromBuilding

• fetchTilesFromBuilding(building: Building): Promise<any>

  (Experimental) Downloads the tiled-map of a certain building

  Parameters

  • building: Building

    Building whose tiles will be downloaded

  Returns Promise<any>

StaticgetDeviceId

• getDeviceId(): Promise<string>

  Returns the device identifier that has generated the location

  Returns Promise<string>

Staticinit

• init(): undefined | void

  Initializes SitumPlugin.

  This method must be called before invoking any other methods. This method can be safely called many times as it will only initialise the SDK if it is not already initialised.

  Returns undefined | void

  void

  Throws

  Exception

StaticinternalSetMethodCallMapDelegate

• internalSetMethodCallMapDelegate(
      callback: (internalCall: InternalCall) => void,
  ): void

  INTERNAL METHOD.

  Set a native MethodCall delegate. Do not use this method as it is intended for internal use by the map viewer module.

  Parameters

  • callback: (internalCall: InternalCall) => void

  Returns void

StaticinvalidateCache

• invalidateCache(): undefined | void

  Invalidate all the resources in the cache

  Returns undefined | void

  void

  Throws

  Exception

StaticonEnterGeofences

• onEnterGeofences(callback: (event: Geofence) => void): void

  Callback that notifies when the user enters a Geofence.

  In order to use correctly these callbacks you must know the following:

  • Positioning geofences (with trainer_metadata custom field) won't be notified.
  • These callbacks only work with indoor locations. Any outdoor location will produce a call to onExitedGeofences with the last positioned geofences as argument.

  Parameters

  • callback: (event: Geofence) => void

    the function called when the user enters a Geofence

  Returns void

StaticonExitGeofences

• onExitGeofences(callback: (event: Geofence) => void): void

  Callback that notifies when the user exits a Geofence.

  In order to use correctly these callbacks you must know the following:

  • Positioning geofences (with trainer_metadata custom field) won't be notified.
  • These callbacks only work with indoor locations. Any outdoor location will produce a call to onExitedGeofences with the last positioned geofences as argument.

  Parameters

  • callback: (event: Geofence) => void

    the function called when the user exits a Geofence

  Returns void

StaticonLocationError

• onLocationError(callback: (error: Error) => void): void

  Callback that notifies when there is an error while the user is positioining.

  Parameters

  • callback: (error: Error) => void

    the function called when there is an error

  Returns void

StaticonLocationStatus

• onLocationStatus(callback: (status: LocationStatus) => void): void

  Callback that notifies when the user LocationStatus changes.

  Parameters

  • callback: (status: LocationStatus) => void

    the function called when the user LocationStatus changes

  Returns void

StaticonLocationStopped

• onLocationStopped(callback: () => void): void

  Callback that notifies when the user stops positioning.

  Parameters

  • callback: () => void

    the function called when the user stops positioning.

  Returns void

StaticonLocationUpdate

• onLocationUpdate(callback: (location: Location) => void): void

  Callback that notifies when the user Location changes.

  Parameters

  • callback: (location: Location) => void

    the function called when the user Location changes

  Returns void

StaticonNavigationCancellation

• onNavigationCancellation(callback: () => void): void

  Callback that notifies when the user does cancel the navigation.

  Parameters

  • callback: () => void

    the function called when the user cancels the navigation.

  Returns void

StaticonNavigationDestinationReached

• onNavigationDestinationReached(callback: (route: Route) => void): void

  Callback that notifies when the user reaches the destination POI.

  Parameters

  • callback: (route: Route) => void

    a function that returns the completed Route by parameters.

  Returns void

StaticonNavigationError

• onNavigationError(callback: (error: any) => void): void

  Callback that notifies when there is an error during navigation.

  Parameters

  • callback: (error: any) => void

    the function called when there is an error during navigation.

  Returns void

StaticonNavigationFinished

• onNavigationFinished(callback: () => void): void

  Parameters

  • callback: () => void

    the function called when the user finishes the route.

  Returns void

  Deprecated

  DEPRECATED: Use instead onNavigationCancellation() and onNavigationDestinationReached() to determine why did the navigation end.

  Callback that notifies when the user finishes the route.

StaticonNavigationOutOfRoute

• onNavigationOutOfRoute(callback: () => void): void

  Callback that notifies when the user gets out of the current route.

  Parameters

  • callback: () => void

    the function called when the user gets out of the current route.

  Returns void

StaticonNavigationProgress

• onNavigationProgress(callback: (progress: NavigationProgress) => void): void

  Callback that notifies every progress the user makes while navigating.

  Parameters

  • callback: (progress: NavigationProgress) => void

    a function that returns the NavigationProgress by parameters.

  Returns void

StaticonNavigationStart

• onNavigationStart(callback: (route: Route) => void): void

  Callback that notifies when navigation starts.

  Parameters

  • callback: (route: Route) => void

    a function that returns the initial Route by parameters.

  Returns void

StaticremoveLocationUpdates

• removeLocationUpdates(): undefined | void

  Stops positioning, removing all location updates

  Returns undefined | void

StaticremoveNavigationUpdates

• removeNavigationUpdates(): Promise<void>

  Removes all location updates. This removes the internal state of the manager, including the listener provided in requestNavigationUpdates(NavigationRequest, NavigationListener), so it won't receive more progress updates.

  Returns Promise<void>

StaticremoveRealTimeUpdates

• removeRealTimeUpdates(_callback?: Function): undefined | void

  Removes all real time updates listners.

  Parameters

  • Optional_callback: Function

  Returns undefined | void

StaticrequestDirections

• requestDirections(
      building: Building,
      from: Point | Location,
      to: Poi | Point,
      directionOptions?: DirectionsOptions,
  ): Promise<any>

  Calculates a route between two points. The result is provided asynchronously using the callback.

  Parameters

  • building: Building

    Building
  • from: Point | Location

    Point route origin
  • to: Poi | Point

    Point route destination
  • OptionaldirectionOptions: DirectionsOptions

    DirectionsOptions

  Returns Promise<any>

StaticrequestLocationUpdates

• requestLocationUpdates(locationRequest?: LocationRequest): undefined | void

  Starts positioning.

  Parameters

  • OptionallocationRequest: LocationRequest

    Positioning options to configure how positioning will behave

  Returns undefined | void

StaticrequestNavigationUpdates

• requestNavigationUpdates(options?: NavigationRequest): undefined | void

  Set the navigation params, and the listener that receives the updated navigation progress.

  Can only exist one navigation with one listener at a time. If this method was previously invoked, but removeLocationUpdates() wasn't, removeLocationUpdates() is called internally.

  Parameters

  • Optionaloptions: NavigationRequest

    NavigationRequest

  Returns undefined | void

StaticrequestRealTimeUpdates

• requestRealTimeUpdates(
      realtimeUpdates: (event: any) => void,
      error?: (event: any) => void,
      options?: any,
  ): undefined | void

  Requests a real time devices positions

  Parameters

  • realtimeUpdates: (event: any) => void

    callback to use when new device positions are updated
  • Optionalerror: (event: any) => void

    callback to use when an error on navigation udpates raises
  • Optionaloptions: any

    Represents the configuration for getting realtime devices positions in

  Returns undefined | void

StaticsdkVersion

• sdkVersion(): undefined | SdkVersion

  Returns undefined | SdkVersion

  void

  Deprecated

  DEPRECATED: this method will not work anymore.

  Gets the list of versions for the current plugin and environment

  Throws

  Exception

StaticsetApiKey

• setApiKey(apiKey: string): undefined | void

  Provides your API key to the Situm SDK.

  This key is generated for your application in the Dashboard. Old credentials will be removed.

  Parameters

  • apiKey: string

    user's apikey.

  Returns undefined | void

  void

  Throws

  Exception

StaticsetConfiguration

• setConfiguration(options: ConfigurationOptions): undefined | void

  Sets the SDK ConfigurationOptions.

  Parameters

  • options: ConfigurationOptions

    ConfigurationOptions

  Returns undefined | void

  void

  Throws

  Exception

StaticsetDashboardURL

• setDashboardURL(url: string): undefined | void

  Sets the API's base URL to retrieve the data.

  Parameters

  • url: string

    user's email.

  Returns undefined | void

  void

  Throws

  Exception

StaticsetUseRemoteConfig

• setUseRemoteConfig(useRemoteConfig: boolean): undefined | void

  Set to true if you want the SDK to download the configuration from the Situm API and use it by default. Right now it only affects the LocationRequest. Default value is true from SDK version 2.83.5

  Parameters

  • useRemoteConfig: boolean

  Returns undefined | void

  void

  Throws

  Exception

StaticsetUserPass

• setUserPass(email: string, password: string): undefined | void

  Provides user's email and password. This credentials will be used to obtain a valid user token to authenticate the server request, when necessary. Token obtaining is not necessary done when this method is executed. Old credentials will be removed.

  Parameters

  • email: string

    user's email.
  • password: string

    user's password.

  Returns undefined | void

  void

  Throws

  Exception

StaticspeakAloudText

• speakAloudText(message: TextToSpeechMessage): undefined | void

  INTERNAL METHOD.

  Internal method that handles the required logic to speak aloud MapView messages.

  Parameters

  • message: TextToSpeechMessage

    The message that will be spoken aloud. See TextToSpeechMessage

  Returns undefined | void

StaticupdateNavigationState

• updateNavigationState(externalNavigation: Map<string, any>): undefined | void

  INTERNAL METHOD.

  Update SDK with the viewer navigation states. Do not use this method as it is intended for internal use by the map viewer module.

  Parameters

  • externalNavigation: Map<string, any>

  Returns undefined | void

StaticupdateNavigationWithLocation

• updateNavigationWithLocation(location: Location): undefined | void

  Informs NavigationManager object the change of the user's location

  Parameters

  • location: Location

    new Location of the user. If null, nothing is done

  Returns undefined | void

StaticvalidateMapViewProjectSettings

• validateMapViewProjectSettings(): void

  INTERNAL METHOD.

  Validate if the mapView internal settings have been properly configured Do not use this method as it is intended for internal use by the map viewer module.

  Returns void