Package com.trimblemaps.navigation.plugins.poisonroute.model

Class PoisOnRouteOptions

java.lang.Object
com.trimblemaps.navigation.plugins.poisonroute.model.PoisOnRouteOptions
All Implemented Interfaces:
android.os.Parcelable
public abstract class PoisOnRouteOptions extends Object implements android.os.Parcelable
Create a PlaceOptions object which can be used to customize the autocomplete geocoder results and the UI component. There are two modes to further change the autocomplete UI to fit your app better.
  • Full screen mode: will place all the search history, results, and injected places into a view which has a width equal to the app width.
  • Card view mode: the place search history, results, and injected places in into a CardView
Since:
0.1.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PoisOnRouteOptions.Builder
    Build a new instance of the PoisOnRouteOptions class using this inner builder class.

    Nested classes/interfaces inherited from interface android.os.Parcelable

    android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_TIMEOUT
    Default timeout in milliseconds for the request to find POIs along the route
    static final int
    MODE_FLOATING
    Mode for launching the autocomplete view as a floating overlay
    static final int
    MODE_FULLSCREEN
    Mode for launching the autocomplete view in fullscreen.

    Fields inherited from interface android.os.Parcelable

    CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

  • Constructor Summary

    Constructors
    Constructor
    Description
    PoisOnRouteOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static PoisOnRouteOptions.Builder
    builder()
    Build a new instance of the PoisOnRouteOptions class using this method.
    com.trimblemaps.api.poi.v1.TrimbleMapsPois.Builder
    buildPoiSearch()
     
    List<com.trimblemaps.geojson.Point>
    coordinates()
    Coordinates describing the route (origin, destination and any intermediate stops)
    abstract List<com.trimblemaps.api.directions.v1.models.DirectionsRoute>
    directions()
    The list of directions, to be used to draw the route on the map
    abstract Integer
    geometryIndex()
     
    abstract Integer
    legIndex()
     
    abstract Double
    maxDistanceAhead()
    The maximum distance (in meters) to look ahead on the route for POIs
    abstract com.trimblemaps.mapsdk.plugins.places.autocomplete.model.PlaceOptions
    placeOptions()
    PlaceOptions contains a number of options to control the UI and search
    abstract com.trimblemaps.api.directions.v1.models.RouteOptions
    routeOptions()
    The RouteOptions that should be used when finding POIs along the route (contains the coordinates of the route, the routing profile, etc.)
    abstract int
    timeout()
    The timeout in milliseconds for the request to find POIs along the route
    abstract String
    tripId()
     
    abstract int
    viewMode()
    Set the autocomplete's layout view mode to MODE_FULLSCREEN, or @link #MODE_FLOATING} which determines which layout you'd like to use for your autocomplete view.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface android.os.Parcelable

    describeContents, writeToParcel

  • Field Details

    • MODE_FULLSCREEN

      public static final int MODE_FULLSCREEN
      Mode for launching the autocomplete view in fullscreen.
      Since:
      0.1.0
      See Also:

    • MODE_FLOATING

      public static final int MODE_FLOATING
      Mode for launching the autocomplete view as a floating overlay
      Since:
      0.1.0
      See Also:

    • DEFAULT_TIMEOUT

      public static final int DEFAULT_TIMEOUT
      Default timeout in milliseconds for the request to find POIs along the route
      See Also:

  • Constructor Details

    • PoisOnRouteOptions

      public PoisOnRouteOptions()

  • Method Details

    • placeOptions

      @Nullable public abstract com.trimblemaps.mapsdk.plugins.places.autocomplete.model.PlaceOptions placeOptions()
      PlaceOptions contains a number of options to control the UI and search
      Returns:
      the number of past search results returned by the geocoder

    • routeOptions

      @NonNull public abstract com.trimblemaps.api.directions.v1.models.RouteOptions routeOptions()
      The RouteOptions that should be used when finding POIs along the route (contains the coordinates of the route, the routing profile, etc.)
      Returns:
      the route options used

    • tripId

      @Nullable public abstract String tripId()

    • legIndex

      @Nullable public abstract Integer legIndex()

    • geometryIndex

      @Nullable public abstract Integer geometryIndex()

    • coordinates

      @NonNull public List<com.trimblemaps.geojson.Point> coordinates()
      Coordinates describing the route (origin, destination and any intermediate stops)
      Returns:
      the list of coordinates describing the route

    • maxDistanceAhead

      @Nullable public abstract Double maxDistanceAhead()
      The maximum distance (in meters) to look ahead on the route for POIs
      Returns:
      maximum distance in meters

    • viewMode

      public abstract int viewMode()
      Set the autocomplete's layout view mode to MODE_FULLSCREEN, or @link #MODE_FLOATING} which determines which layout you'd like to use for your autocomplete view.
      Returns:
      an integer representing either the MODE_FULLSCREEN mode
      Since:
      0.1.0

    • timeout

      public abstract int timeout()
      The timeout in milliseconds for the request to find POIs along the route
      Returns:
      an integer representing the timeout in milliseconds

    • directions

      @Nullable public abstract List<com.trimblemaps.api.directions.v1.models.DirectionsRoute> directions()
      The list of directions, to be used to draw the route on the map
      Returns:

    • buildPoiSearch

      public com.trimblemaps.api.poi.v1.TrimbleMapsPois.Builder buildPoiSearch()

    • builder

      public static PoisOnRouteOptions.Builder builder()
      Build a new instance of the PoisOnRouteOptions class using this method. It will return the PoisOnRouteOptions.Builder which can be used to customize the users experience.
      Returns:
      an instance of PoisOnRouteOptions.Builder used to create a new PoisOnRouteOptions instance
      Since:
      0.1.0