What3WordsV3 class

Instances of the What3WordsV3 class provide access to Version 3 of the what3words API.

Constructors

What3WordsV3(String apiKey)

Get a new API manager instance.

What3WordsV3.withEndpoint(String apiKey, String endpoint)

Get a new API manager instance.

What3WordsV3.withHeaders(String apiKey, String endpoint, Map<String, String> headers)

Get a new API manager instance. apiKey Your what3words API key obtained from https://accounts.what3words.com endpoint override the default public API endpoint headers add any custom HTTP headers to send in each request

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

autosuggest(String input, {AutosuggestOptions? options}) → AutosuggestRequestBuilder

AutoSuggest can take a slightly incorrect 3 word address, and suggest a list of valid 3 word addresses. It has powerful features which can, for example, optionally limit results to a country or area, and prefer results which are near the user. For full details, please see the complete API documentation at https://docs.what3words.com/api/v3/#autosuggest

autosuggestSelection(String rawInput, String sourceApi, String words, int rank, {AutosuggestOptions? options}) → AutosuggestSelectionRequestBuilder

autosuggest-selection enables simple reporting for what3words address selections in accounts.what3words.com. It should be called once in conjunction with autosuggest or autosuggest-with-coordinates. when an end user picks a what3words address from the suggestions presented to them. rawInput The full or partial 3 word address used on the autosuggest or autosuggest-with-coordinates call. sourceApi The source of the selected autosuggest, can be 'text' or 'voice'. words The 3 word address of the selected suggestion. rank The rank of the selected suggestion. options The autosuggest options used on the autosuggest or autosuggest-with-coordinates call. returns a AutosuggestWithCoordinatesRequestBuilder instance suitable for invoking a autosuggest API request

autosuggestWithCoordinates(String input, {AutosuggestOptions? options}) → AutosuggestWithCoordinatesRequestBuilder

AutoSuggestWithCoordinates can take a slightly incorrect 3 word address, and suggest a list of valid 3 word addresses including coordinates. It has powerful features which can, for example, optionally limit results to a country or area, and prefer results which are near the user. For full details, please see the complete API documentation at https://docs.what3words.com/api/v3/#autosuggest

availableLanguages() → AvailableLanguagesRequestBuilder

Retrieves a list all available 3 word address languages, including the ISO 639-1 2 letter code, english name and native name.

convertTo3wa(Coordinates coordinates) → ConvertTo3WARequestBuilder

Convert a latitude and longitude to a 3 word address, in the language of your choice. It also returns country, the bounds of the grid square, a nearest place (such as a local town) and a link to our map site.

convertToCoordinates(String words) → ConvertToCoordinatesRequestBuilder

Convert a 3 word address to a latitude and longitude. It also returns country, the bounds of the grid square, a nearest place (such as a local town) and a link to our map site.

gridSection(Coordinates southwest, Coordinates northeast) → GridSectionRequestBuilder

Returns a section of the 3m x 3m what3words grid for a bounding box. The bounding box is specified by lat,lng,lat,lng as south,west,north,east.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

what3words() → What3WordsV3Service

Operators

operator ==(Object other) → bool

The equality operator.

inherited