StructuredSearchSession
A class that manages a single structured search session against the StructuredSearch. The search proceeds as a series of steps and intermediate searches.
Important: This is a Public Preview API. It may be changed or removed at any time.
Functions
Perform a synchronous action to fetch the current structured search state. This can be used to retrieve the initial state with candidates representing the top level of address, such as country.
Perform an asynchronous action to fetch the current structured search state. This can be used to retrieve the initial state with candidates representing the top level of address, such as country.
Perform a synchronous action to go back to previous selection from current step. step must be a positive value. If step is larger than the number of steps that have been taken, e.g. goBack is called with step set to 9 at the third step, it goes back to the first step.
Perform a synchronous action to select a specific candidate in the current step. This will advance to the next step of the search path.
Perform an asynchronous action to select a specific candidate in the current step. This will advance to the next step of the search path.
Perform a synchronous action to set locale for the search session. The locale is used to find the best representation of strings in StructuredSearchCandidate. If the locale is empty, e.g. Locale.ROOT, the session locale remains the same.
Perform an asynchronous action to set locale for the search session. The locale is used to find the best representation of strings in StructuredSearchCandidate. If the locale is empty, e.g. Locale.ROOT, the session locale remains the same.