Telogis.GeoBase.Geocoding Namespace

The AutocompleteGeocoder class takes partial address strings, and generates a list of full address suggestions. This can be used to implement an interactive address search, in which suggested addresses are displayed in near real-time as a user types.

An object encapsulating one-line arguments for Geocode Overload.

A base class used to provide fields for structured and one-line Autocomplete Geocoder arguments.

AutocompleteGeocoderPartialResult objects are provided to a callback function provided to Geocode Overload. They contain an array of AutocompleteGeocoderSuggestion objects representing addresses which matched the search string. Collectively, all the AutocompleteGeocoderPartialResult objects returned for a particular Geocode will form the same complete set of results returned in the AutocompleteGeocoderResult returned by the Geocode Overload call.

AutocompleteGeocoderResult objects are returned as a result of a call to Geocode Overload. They contain SearchResult information on how the search terminated, together with an array of AutocompleteGeocoderSuggestion objects representing addresses which matched the search string.

AutocompleteGeocoderResultHint objects can be provided to Geocode Overload. They contain information on a previous search that can be used as a hint for the new search. For example, providing a result hint based on a previous search for "100 main st, cambri" means that a subsequent search for "100 main st, cambrid" can quickly provide some initial results. This is best used in combination with an incremental results callback. Note: When an AutocompleteGeocoderResultHint is provided to a Geocode, it is assumed that the Geocode arguments are the same for each (excluding the search query). For example, it will assume that the location hint and countries are the same.

AutocompleteGeocoderSuggestion objects represent potential matches produced by the AutocompleteGeocoder in response to a search string. These correspond to either street addresses or regions (e.g. Cities, States) contained in the GBFS data.

Custom arguments to pass to a Location Search operation.

Object for specifying extended structured geocode arguments.

A base class used to provide fields for structured and one-line geocode arguments.

LocationSearch provides a single API to search for locations across different sources, such as geocoders, POI sources, and reverse geocoders. By default, GeoBase geocoders are used, but additional sources can be provided using AddSearchSource(LocationSearchSource).

An object encapsulating one-line arguments for LocationSearch(LocationSearchBaseArgs).

A base class used to provide fields for one-line and structured Location Search arguments.

A search operation for GeoBase's LocationSearch API that can find location search results.

LocationSearchResult objects are returned as a result of a call to Search. They contain SearchResult information on how the search terminated, together with an array of LocationSearchSuggestion objects representing locations which matched the search string.

A search source for GeoBase's location search API. Custom search sources can be implemented by creating a subclass of this class and creating an associated subclass of LocationSearchOperation. Subclasses are normally implemented as a singleton.

LocationSearchSuggestion objects represent matches produced by the LocationSearch class in response to a search string.

Object for specifying one-line geocode arguments.

A specialized search operation for GeoBase's location search API for use with relative queries such as 'hotels in aliso viejo'. Custom relative search operations can subclass this, along with RelativeSource, to provide access to other kinds of relative query results other than built in point of interest results.

A specialized search source for GeoBase's location search API for use with relative queries such as 'hotels in aliso viejo'. Custom relative sources can subclass this, along with RelativeSearchOperation, to provide access to other kinds of relative query results other than built in point of interest results.

An object encapsulating structured arguments for Geocode Overload.

Object for specifying structured geocode arguments.

An object encapsulating structured arguments for LocationSearch(LocationSearchBaseArgs).

An interface for the arguments supplied to a search operation.

An interface for a search suggestion that is part of the search results for a search operation.

Determines the strictness used when matching an address candidate against a search query. In most cases, a combination value such as "Permissive" or "Strict" should be used. However, you can create combinations of the other enumeration values by using the bitwise OR (|) operator.

An enumeration of the different types of results that can be excluded from the results of an autocomplete geocoding operation.

An enumeration of the different types of results that can be returned by the AutocompleteGeocoder.

Determines the desired behavior when hitting the results limit; higher depths result in more effort finding better results. Use SearchDepth.Low to return the first results found. SearchDepth.Medium and SearchDepth.High can take longer to find results, but the average quality is higher. Note that two AutoCompleteGeocoder calls with the same AutocompleteGeocoderArgs may produce different results when using a AutocompleteGeocoder.SearchDepth value other than SearchDepth.Low.

Specifies whether a query is a prefix or full query, which may influence how searching is performed.

Possible result types for search results.

Specifies the desired depth of the search. A low depth is best suited to user interfaces that need to be highly responsive; a high depth is best suited to contexts where high quality results are particularly important, at the sacrifice of search speed.

An enumeration for the types of relative search queries.