Package es.situm.sdk.location

Class LocationParametersUpdate.Builder

java.lang.Object
es.situm.sdk.location.LocationParametersUpdate.Builder
Enclosing class:
LocationParametersUpdate
public static final class LocationParametersUpdate.Builder extends Object

  • Constructor Details

  • Method Details

    • buildingIdentifier

      @NonNull public LocationParametersUpdate.Builder buildingIdentifier(@NonNull String buildingIdentifier)
      Identifier of the building. This must be a valid building, so custom identifiers may not work with this functionality.
      Parameters:
      buildingIdentifier - string that contains an identifier of the building

    • routeId

      public LocationParametersUpdate.Builder routeId(int routeId)
      Identifier of the route. This parameter needs to be greater than 0, usually an auto-incremente integer.
      Parameters:
      routeId - unique integer. Must be managed by the app

    • locationDelimitedByRoute

      public LocationParametersUpdate.Builder locationDelimitedByRoute(boolean locationDelimitedByRoute)
      Boolean value that determines if the location engine have to consider points (true) or not (false) when computing location.
      Parameters:
      locationDelimitedByRoute - boolean value.

    • addRoutePoints

      public LocationParametersUpdate.Builder addRoutePoints(@NonNull List<Point> routePoints)
      Ordered list of points the location engine will use to compute locations. All the points must be located inside the building identified by buildingIdentifier parameter, and contained in the dimensions of the building. Additionally they need to include valid floors. Usually these points can be calculated with the Route object
      Parameters:
      routePoints - list of indoor Point referenced to the building

    • updateDevicesToFollow

      public LocationParametersUpdate.Builder updateDevicesToFollow(boolean updateDevicesToFollow)
      (De)Active parameter to update. When this feature is active the location system will listen for every device listed on LocationParametersUpdate.getDevicesToFollow() and creates a new location (copy) for that device.
      Parameters:
      updateDevicesToFollow - boolean value that indicates if this update should be processed (true) or not (false).

    • devicesToFollow

      public LocationParametersUpdate.Builder devicesToFollow(List<String> devicesToFollow)
      List of identifiers of the device that needs to be followed.
      Parameters:
      devicesToFollow - list of device identifier. Every identifier must only contain digits.

    • build

      @NonNull public LocationParametersUpdate build()