LocationSearchSource Class

The group name of the search source. Related sources can share search arguments by using the same group name. Can be overridden by subclasses to specify a group name, which is then used as the prefix for argument names when presented to users of LocationSearch. Defaults to null, meaning that Name is used as the argument name prefix instead.

Specifies the result types handled by this source.

The name of the search source, for use for things such as prefixing custom search arguments. Must be unique across search source.

Indicates whether the search spends most of its time waiting for results from an external server. If true, this indicates that the Location Search can continue searching other sources while waiting for this source to complete, reducing total search time.

Create and return a new search operation for the search source, using the provided arguments. The search operation should be returned unstarted.

Determines whether the specified object is equal to the current object.

Returns a list of custom arguments for this search source that can be specified in the CustomArgs property of a LocationSearchBaseArgs object. Argument names are automatically prefixed by the search source group name or name when presented to users of LocationSearch, however will always be provided to individual search sources without these prefixes.

Serves as the default hash function.

Specifies result types that will be excluded for search sources with a lower priority than this when IsApplicableToSearch(LocationSearchBaseArgs) returns true for the same search arguments. This could be used, for example, to restrict further searching for queries that match a format specific to this source, but for which there are no results.

Specifies result types that will be excluded for search sources with a lower priority than this when the source returns any results. If it does not return results, searching of other sources will continue as normal. This should generally be used only when the presence of results from this source implies that results from other sources are unlikely.

Gets the Type of the current instance.

Determines whether the search source is applicable for a particular search.

Determines the priority of the search source for a particular search. The priority is used to determine the order in which search sources are queried; sources with a higher priority are searched first.

Returns a string that represents the current object.

The default priority value to use for geocoding operations.

The default priority value to use for POI searches.

The default prioriy value to use for POI searches that are relative to a certain location, e.g. in Aliso Viejo.

The default priority value to use for reverse geocode operations.

The maximum priority value to use for search operations.

The priority level at which remote operations are started. Sources with higher priority should be extremely quick and exclude further sources when they find results. This avoids the need to begin costly network requests when we can quickly determine that they are not needed.