what3words.dotnet.wrapper 3.1.0

w3w-dotnet-wrapper

An .NET library to use the what3words v3 API.

API methods are grouped into a single service object which can be centrally managed by a What3WordsV3 instance. It will act as a factory for all of the API endpoints and will automatically initialize them with your API key.

Installation

The artifact is available through NuGet Package

Documentation

See the what3words public API documentation

Setup

To obtain an API key, please visit https://what3words.com/select-plan and sign up for an account.

var wrapper = new What3WordsV3("YOUR_API_KEY_HERE");

If you run our Enterprise Suite API Server yourself, you may specify the URL to your own server like so:

var wrapper = new What3Words("YOUR_API_KEY_HERE", "https://api.yourserver.com")

Usage

• ConvertTo3WA() - Convert a coordinate (latitude and longitude) to a 3 word address:

var result = await wrapper.ConvertTo3WA(new Coordinates(51.222011, 0.152311)).RequestAsync();

• ConvertToCoordinates() - Convert a 3 word address to a coordinate (latitude and longitude):

var result = await wrapper.ConvertToCoordinates("filled.count.soap").RequestAsync();

• Autosuggest() - AutoSuggest can take a slightly incorrect 3 word address, and suggest a list of valid 3 word addresses. For more autosuggest proprieties similar to focus below go to our documentation

var result = await wrapper.Autosuggest("index.home.r", new AutosuggestOptions().SetFocus(51.502,-0.12345)).RequestAsync();

• GridSection() - Returns a section of the 3m x 3m what3words grid for a bounding box (Coordinats SW, Coordinates NE).

var result = await wrapper.GridSection(new Coordinates(51.222011, 0.152311), new Coordinates(51.222609, 0.152898)).RequestAsync();

• AvailableLanguages() - Retrieves a list all available 3 word address languages.

var result = await wrapper.AvailableLanguages().RequestAsync();

• IsPossible3wa() - This method takes a string as a parameter and returns whether the string is in the format of a 3WA (eg "filled.count.soap"). Return type is boolean.

  ⚠️ NOTE: Does not check if it is an actual existing 3WA.

var result = wrapper.IsPossible3wa("filled.count.so"); // true

• FindPossible3wa() - This method takes a string as a parameter and searches the string for any possible instances of a 3WA - e.g. "leave in my porch at word.word.word." Likely to be the main method that is called on the delivery notes. Returns an array of matched items. Returns an empty array if no matches are found.

  ⚠️ NOTE: Does not check if it is an actual existing 3WA.

var result = wrapper.FindPossible3wa("from index.home.raft to filled.count.soap"); // IEnumerable<string>[ "index.home.raft", "filled.count.soap"]

• IsValid3wa() - This method takes a string as a parameter and first passes it through the W3W regex filter (akin to calling isPossible3wa() on the string) and then calls the W3W api to verify it is a real 3WA.

var result = wrapper.IsValid3wa("filled.count.soap"); // true

Tests

To run the tests, you need to provide the following environment variables:

• W3W_API_KEY - A valid API Key (with autosuggest with coordinates enabled - otherwise tests related to v3/autosuggest-with-endpoint will fail)
• W3W_API_ENDPOINT - (optional) You can override the default endpoint which is https://api.what3words.com (perhaps a self hosted or a local instance of the what3words api).

dotnet test what3words.dotnet.wrapper.utests/what3words.dotnet.wrapper.utests.csproj

Test run for /w3w-dotnet-wrapper/what3words.dotnet.wrapper.utests/bin/Debug/netcoreapp3.1/what3words.dotnet.wrapper.utests.dll(.NETCoreApp,Version=v3.1)
Microsoft (R) Test Execution Command Line Tool Version 16.7.1
Copyright (c) Microsoft Corporation.  All rights reserved.

Starting test execution, please wait...

A total of 1 test files matched the specified pattern.

Test Run Successful.
Total tests: 42
     Passed: 42
 Total time: 7.0222 Seconds