Package com.trimblemaps.mapsdk.plugins.places.searchflow.model

Class SearchFlowOptions

java.lang.Object
com.trimblemaps.mapsdk.plugins.places.searchflow.model.SearchFlowOptions
All Implemented Interfaces:
android.os.Parcelable
public abstract class SearchFlowOptions 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 
    SearchFlowOptions.Builder
    Build a new instance of the PlaceOptions 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
    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
    SearchFlowOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static SearchFlowOptions.Builder
    builder()
    Build a new instance of the PlaceOptions class using this method.
    abstract PlaceOptions
    placeOptions()
    Limit the number of results returned.
    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:

  • Constructor Details

    • SearchFlowOptions

      public SearchFlowOptions()

  • Method Details

    • placeOptions

      @Nullable public abstract PlaceOptions placeOptions()
      Limit the number of results returned. The default is the maximum number of historical searches already saved by the Places plugin.
      Returns:
      the number of past search results returned by the geocoder
      Since:
      0.9.0

    • 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

    • builder

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