Swift

You can install this with Swift Package Manager by adding the URL below under Swift Packages under your project settings:

You can use CocoaPods to install w3w-swift-wrapper by adding it to the target in your Podfile:

In any swift file you use the what3words API, import the following:

Use the following code with your API key to initialize the API:

In the case that you run our Enterprise Suite API Server yourself, you may specifty the URL to your own server like so:

Additionally, if you run the Enterprise Suite API Server there is another optional setup() parameter: customHeaders. Use this if you need to send custom headers to your own server:

Each call takes a completion block as the last parameter. This allows Swift’s trailing closure syntax to be used. The closure’s parameters contain the results. If there was a problem with any call, it will be indicated by the error object.

Convert coordinates, expressed as latitude and longitude to a 3 word address.

This function takes the latitude and longitude as a CLLocationCoordinate2D object

The values returned from the convertTo3wa method are described in the API documentation.

Convert a 3 word address to a position, expressed as coordinates of latitude and longitude.

This function takes the words parameter as a string of 3 words 'table.book.chair'

The values returned from the convertToCoordinates method are described in the API documentation.

Returns a list of 3 word addresses based on user input and other parameters.

This method provides corrections for the following types of input error:

• typing errors
• spelling errors
• misremembered words (e.g. singular vs. plural)
• words in the wrong order

The autosuggest method determines possible corrections to the supplied 3 word address string based on the probability of the input errors listed above and returns a ranked list of suggestions. This method can also take into consideration the geographic proximity of possible corrections to a given location to further improve the suggestions returned.

• voice
  If you have a VoiceAPI enabled account, you may also call autosuggest with audio data for voice recognition. In order for this to work, you must add a Voice API plan to your account. There is a minimal example of this below, but detailed information can be found here

Input 3 word address
You will only receive results back if the partial 3 word address string you submit contains the first two words and at least the first character of the third word; otherwise an error message will be returned.

We have prepared a regex, and example code to help you filter results before calling autosuggest. Please see our regex documentation

Clipping and Focus

We provide various clip policies to allow you to specify a geographic area that is used to exclude results that are not likely to be relevant to your users. We recommend that you use the clipping to give a more targeted, shorter set of results to your user. If you know your user’s current location, we also strongly recommend that you use the focus to return results which are likely to be more relevant.

In summary, the clip policy is used to optionally restrict the list of candidate autosuggest results, after which, if focus has been supplied, this will be used to rank the results in order of relevancy to the focus.

The values returned from the autosuggest method are described in the what3words REST API documentation.

Usage

The first parameter is the partial three words, or voice data. The second optional parameter is the options for the autosuggest function. The last parameter is the completion block.

Focus on one particular place

Focus on (51.4243877,-0.34745) and ask for suggestions from a French three word fragment:

Voice API Example

The what3words Voice API allows a user to say three words into any application or service, with it returning a configurable list of what3words address suggestions, all through a single API call.

In order for this to work, you must add a Voice API plan to your account.

This example instantiates a W3WMicrophone which provides an audio stream to autosuggest(audio:) which begins recording when autosuggest is called. For information on W3WMicrophone and customizing your own W3WAudioStream for autosuggest(audio:) see the Voice API README.

Also, W3WMicrophone has a callback closure W3WMicrophone.volumeUpdate: (Double) -> () that provides amplitude information useful for animating user feedback. See the the Voice API example, and more information is avialable in the VoiceAPI README.

This function returns the currently supported languages for text based autosuggest(text:) calls. It will return the two letter code (ISO 639), and the name of the language both in that language and in English.

The values returned from the convertTo3wa method are described in the what3words REST API documentation

For the available Voice API langauges call api.availableVoiceLanguages(completion:) which works exactly the same way.

Returns a section of the 3m x 3m what3words grid for a given area. The requested box must not exceed 4km from corner to corner, or a BadBoundingBoxTooBig error will be returned. Latitudes must be >= -90 and <= 90, but longitudes are allowed to wrap around 180. To specify a bounding-box that crosses the anti-meridian, use longitude greater than 180. Example value: 50.0, 179.995, 50.01, 180.0005.

The values returned from the gridSection function are described in the what3words REST API documentation

These are some functions that will search or validate what3words addresses.

isPossible3wa(text: String) -> Bool

Check to see if the text follows the form of a what3words address via regex, that is, a word followed by a separator followed by a word. A word is defined as a series of letters that belong to any writing system. This does not validate the address as being a real location on the earth, just that it follows the textual form of one. For example, xx.xx.xx would pass this test even though it is not a valid address.

This would print the result because even though “abc.def.ghi” is not a valid what3words address, still it does fit the form of one, [word][separator][word][separator][word].

isValid3wa(words: String, completion: @escaping (Bool) -> ())

Verifies that the text is a valid what3words address that successfully represents a square on earth. This makes a call to the API to verify. The other validation functions only run a regex locally.

findPossible3wa(text: String) -> [String]

Finds any number of possible what3words addresses in a block of text. The term “possible what3words addresses” refers to text that matches the regex used in isPossible3wa(), that is, these are pieces of text that appear to be what3words address, but have not been verified against the engine as representing an actual place on earth.

This will print out: ["filled.count.soap", "index.home.raft", "grilled.cheese.sandwhich"]

All functions call the completion block with error as the second parameter. All Swift what3words error types are of enum type and conform to CustomStringConvertible, so they can be used with String(describing: error):