AutocompleteSupportFragment

public class AutocompleteSupportFragment extends Fragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	com.google.android.libraries.places.widget.AutocompleteSupportFragment

Implements a fragment that presents a search box button to the user, which presents a search box UI when clicked. As the user types, the autocomplete service returns Place predictions for places such as businesses, addresses and points of interest. When the user selects a place, the autocomplete service returns the response via the PlaceSelectionListener.

Summary

Public constructors
`AutocompleteSupportFragment()`

Public methods
`static AutocompleteSupportFragment`	`newInstance()` Create a new autocomplete fragment with default config.
`void`	`onActivityResult(int requestCode, int resultCode, @Nullable Intent data)` This method is deprecated.
`void`	`onCreate(@Nullable Bundle savedInstanceState)`
`void`	`onResume()`
`void`	`onSaveInstanceState(Bundle bundle)`
`void`	`onViewCreated(View view, @Nullable Bundle savedInstanceState)`
`AutocompleteSupportFragment`	`setActivityMode(AutocompleteActivityMode mode)` Sets the type of activity to open when a user initiates a query.
`AutocompleteSupportFragment`	`setCountries(String[] countries)` See `setCountries`.
`AutocompleteSupportFragment`	`setCountries(List<String> countries)` Sets countries to restrict results to.
`AutocompleteSupportFragment`	`setCountry(@Nullable String country)` This method is deprecated. Use `setCountries` instead.
`AutocompleteSupportFragment`	`setHint(@Nullable CharSequence hint)` Sets the hint text to display in the search input field when there is no text entered.
`AutocompleteSupportFragment`	`setLocationBias(@Nullable LocationBias locationBias)` Biases the autocomplete results to a particular area.
`AutocompleteSupportFragment`	`setLocationRestriction( @Nullable LocationRestriction locationRestriction )` Restricts the autocomplete results to a particular area.
`AutocompleteSupportFragment`	`setOnPlaceSelectedListener(@Nullable PlaceSelectionListener listener)` Sets a listener that will be notified when a place is selected.
`AutocompleteSupportFragment`	`setPlaceFields(List<Place.Field> placeFields)` Sets the desired fields of the `Place` object returned from selecting an autocomplete result.
`AutocompleteSupportFragment`	`setRegionCode(@Nullable String regionCode)` Sets the unicode country/region code (CLDR) of the location where the request is coming from.
`AutocompleteSupportFragment`	`setText(@Nullable CharSequence text)` Sets the text to display in the search input field.
`AutocompleteSupportFragment`	`setTypeFilter(@Nullable TypeFilter typeFilter)` This method is deprecated. Use `setTypesFilter`.
`AutocompleteSupportFragment`	`setTypesFilter(List<String> placeTypes)` Sets the filter that restricts the type(s) of results returned from the response.

Extension functions
`final @NonNull Flow<@NonNull PlaceSelectionResult>`	`AutocompleteSupportFragmentKt.placeSelectionEvents( @NonNull AutocompleteSupportFragment receiver )` Returns a `Flow` of `PlaceSelectionResult`s that are emitted when a place is selected or an error occurs.

Inherited fields

From androidx.fragment.app.Fragment

@Nullable String

mPreviousWho

Inherited methods

From androidx.fragment.app.Fragment

`void`	`dump( @NonNull String prefix, @Nullable FileDescriptor fd, @NonNull PrintWriter writer, @Nullable String[] args )`
`final boolean`	`equals(Object o)`
`final @Nullable FragmentActivity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final @Nullable Bundle`	`getArguments()`
`final @NonNull FragmentManager`	`getChildFragmentManager()`
`@Nullable Context`	`getContext()`
`@NonNull CreationExtras`	`getDefaultViewModelCreationExtras()`
`@NonNull ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`Object`	`getEnterTransition()`
`Object`	`getExitTransition()`
`final @Nullable FragmentManager`	`getFragmentManager()` This method is deprecated.
`final Object`	`getHost()`
`final int`	`getId()`
`final @NonNull LayoutInflater`	`getLayoutInflater()`
`@NonNull Lifecycle`	`getLifecycle()`
`@NonNull LoaderManager`	`getLoaderManager()` This method is deprecated.
`final @Nullable Fragment`	`getParentFragment()`
`final @NonNull FragmentManager`	`getParentFragmentManager()`
`Object`	`getReenterTransition()`
`final @NonNull Resources`	`getResources()`
`final boolean`	`getRetainInstance()` This method is deprecated.
`Object`	`getReturnTransition()`
`final @NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`Object`	`getSharedElementEnterTransition()`
`Object`	`getSharedElementReturnTransition()`
`final @NonNull String`	`getString(int resId)`
`final @Nullable String`	`getTag()`
`final @Nullable Fragment`	`getTargetFragment()` This method is deprecated.
`final int`	`getTargetRequestCode()` This method is deprecated.
`final @NonNull CharSequence`	`getText(int resId)`
`boolean`	`getUserVisibleHint()` This method is deprecated.
`@Nullable View`	`getView()`
`@NonNull LifecycleOwner`	`getViewLifecycleOwner()`
`@NonNull LiveData<LifecycleOwner>`	`getViewLifecycleOwnerLiveData()`
`@NonNull ViewModelStore`	`getViewModelStore()`
`final boolean`	`hasOptionsMenu()`
`final int`	`hashCode()`
`static @NonNull Fragment`	`instantiate(@NonNull Context context, @NonNull String fname)` This method is deprecated.
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`isMenuVisible()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`onActivityCreated(@Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`onAttach(@NonNull Context context)`
`void`	`onAttachFragment(@NonNull Fragment childFragment)` This method is deprecated.
`void`	`onConfigurationChanged(@NonNull Configuration newConfig)`
`boolean`	`onContextItemSelected(@NonNull MenuItem item)`
`@Nullable Animation`	`onCreateAnimation(int transit, boolean enter, int nextAnim)`
`@Nullable Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)`
`void`	`onCreateContextMenu( @NonNull ContextMenu menu, @NonNull View v, @Nullable ContextMenu.ContextMenuInfo menuInfo )`
`void`	`onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater)` This method is deprecated.
`@Nullable View`	`onCreateView( @NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState )`
`void`	`onDestroy()`
`void`	`onDestroyOptionsMenu()` This method is deprecated.
`void`	`onDestroyView()`
`void`	`onDetach()`
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle savedInstanceState)`
`void`	`onHiddenChanged(boolean hidden)`
`void`	`onInflate( @NonNull Context context, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )`
`void`	`onLowMemory()` This method is deprecated.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)`
`boolean`	`onOptionsItemSelected(@NonNull MenuItem item)` This method is deprecated.
`void`	`onOptionsMenuClosed(@NonNull Menu menu)` This method is deprecated.
`void`	`onPause()`
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)`
`void`	`onPrepareOptionsMenu(@NonNull Menu menu)` This method is deprecated.
`void`	`onPrimaryNavigationFragmentChanged( boolean isPrimaryNavigationFragment )`
`void`	`onRequestPermissionsResult( int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults )` This method is deprecated.
`void`	`onStart()`
`void`	`onStop()`
`void`	`onViewStateRestored(@Nullable Bundle savedInstanceState)`
`void`	`postponeEnterTransition()`
`final @NonNull ActivityResultLauncher<I>`	`<I, O> registerForActivityResult( @NonNull ActivityResultContract<I, O> contract, @NonNull ActivityResultCallback<O> callback )`
`void`	`registerForContextMenu(@NonNull View view)`
`final void`	`requestPermissions(@NonNull String[] permissions, int requestCode)` This method is deprecated.
`final @NonNull FragmentActivity`	`requireActivity()`
`final @NonNull Bundle`	`requireArguments()`
`final @NonNull Context`	`requireContext()`
`final @NonNull FragmentManager`	`requireFragmentManager()` This method is deprecated.
`final @NonNull Object`	`requireHost()`
`final @NonNull Fragment`	`requireParentFragment()`
`final @NonNull View`	`requireView()`
`void`	`setAllowEnterTransitionOverlap(boolean allow)`
`void`	`setAllowReturnTransitionOverlap(boolean allow)`
`void`	`setArguments(@Nullable Bundle args)`
`void`	`setEnterSharedElementCallback(@Nullable SharedElementCallback callback)`
`void`	`setEnterTransition(Object transition)`
`void`	`setExitSharedElementCallback(@Nullable SharedElementCallback callback)`
`void`	`setExitTransition(Object transition)`
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated.
`void`	`setInitialSavedState(@Nullable Fragment.SavedState state)`
`void`	`setMenuVisibility(boolean menuVisible)`
`void`	`setReenterTransition(Object transition)`
`void`	`setRetainInstance(boolean retain)` This method is deprecated.
`void`	`setReturnTransition(Object transition)`
`void`	`setSharedElementEnterTransition(Object transition)`
`void`	`setSharedElementReturnTransition(Object transition)`
`void`	`setTargetFragment(@Nullable Fragment fragment, int requestCode)` This method is deprecated.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated.
`boolean`	`shouldShowRequestPermissionRationale(@NonNull String permission)`
`void`	`startActivity(@NonNull Intent intent)`
`void`	`startActivityForResult(@NonNull Intent intent, int requestCode)` This method is deprecated.
`void`	`startIntentSenderForResult( @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options )` This method is deprecated.
`void`	`startPostponedEnterTransition()`
`@NonNull String`	`toString()`
`void`	`unregisterForContextMenu(@NonNull View view)`

Public constructors

AutocompleteSupportFragment

public AutocompleteSupportFragment()

Public methods

newInstance

public static AutocompleteSupportFragment newInstance()

Create a new autocomplete fragment with default config.

onActivityResult

public void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)

onCreate

public void onCreate(@Nullable Bundle savedInstanceState)

onResume

public void onResume()

onSaveInstanceState

public void onSaveInstanceState(Bundle bundle)

onViewCreated

public void onViewCreated(View view, @Nullable Bundle savedInstanceState)

public AutocompleteSupportFragment setActivityMode(AutocompleteActivityMode mode)

Sets the type of activity to open when a user initiates a query.

setCountries

public AutocompleteSupportFragment setCountries(String[] countries)

See setCountries.

setCountries

public AutocompleteSupportFragment setCountries(List<String> countries)

Sets countries to restrict results to.

This must be a list of ISO 3166-1 Alpha-2 country codes (case insensitive). If no countries are set, no country filtering will take place.

This will override values set with setCountry.

Up to five countries are supported. See the components parameter here.

setCountry

public AutocompleteSupportFragment setCountry(@Nullable String country)

See setCountries for details.

This will override countries set with setCountries.

setHint

public AutocompleteSupportFragment setHint(@Nullable CharSequence hint)

Sets the hint text to display in the search input field when there is no text entered.

If the hint is unset or explicitly set to null, the hint text will be set to the default value.

setLocationBias

public AutocompleteSupportFragment setLocationBias(@Nullable LocationBias locationBias)

Biases the autocomplete results to a particular area.

setLocationRestriction

public AutocompleteSupportFragment setLocationRestriction(
    @Nullable LocationRestriction locationRestriction
)

Restricts the autocomplete results to a particular area.

public AutocompleteSupportFragment setOnPlaceSelectedListener(@Nullable PlaceSelectionListener listener)

Sets a listener that will be notified when a place is selected.

Parameters
`@Nullable PlaceSelectionListener listener`	The listener that should be notified.

setPlaceFields

public AutocompleteSupportFragment setPlaceFields(List<Place.Field> placeFields)

Sets the desired fields of the Place object returned from selecting an autocomplete result.

setRegionCode

public AutocompleteSupportFragment setRegionCode(@Nullable String regionCode)

Sets the unicode country/region code (CLDR) of the location where the request is coming from.

The region code field is only supported by Places API (New). Please enable your API key for the Places API (New) in the Google Cloud Console to use region code. If you do not enable your API key for the Places API (New), the region code will not affect the results.

setText

public AutocompleteSupportFragment setText(@Nullable CharSequence text)

Sets the text to display in the search input field.

setTypeFilter

public AutocompleteSupportFragment setTypeFilter(@Nullable TypeFilter typeFilter)

Restricts the autocomplete results to the given place type.

setTypesFilter

public AutocompleteSupportFragment setTypesFilter(List<String> placeTypes)

Sets the filter that restricts the type(s) of results returned from the response.

Up to 5 place types are supported. A comprehensive list of the supported types can be found in com.google.android.libraries.places.api.model.PlaceTypes. The type collections specified in table 3 must be passed in as solo entries and cannot be combined with any other entries from table 1 or 2.

This will override setTypeFilter if both are used.

Extension functions

public final @NonNull Flow<@NonNull PlaceSelectionResult> AutocompleteSupportFragmentKt.placeSelectionEvents(
    @NonNull AutocompleteSupportFragment receiver
)

Returns a Flow of PlaceSelectionResults that are emitted when a place is selected or an error occurs.