Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 6.36 KB

README.md

File metadata and controls

52 lines (40 loc) · 6.36 KB

what3words Samples for what3words libraries and components

This repository contains a set of individual Android Studio projects to help you learn how to use what3words Library. Each sample demonstrates different use cases, complexity levels and APIs.

For more information, please read the documentation.

Gradle Properties

MAPBOX_DOWNLOADS_TOKEN = YOUR_MAPBOX_DOWNLOADS_TOKEN
MAPBOX_ACCESS_TOKEN = YOUR_MAPBOX_ACCESS_TOKEN
MAPS_API_KEY = YOUR_GOOGLE_MAP_API_KEY
PROD_API_KEY = YOUR_W3W_PRODUCTION_KEY

To obtain a PROD_API_KEY key, please visit https://what3words.com/select-plan and sign up for an account. That is used for what3words library.

MAPBOX_DOWNLOADS_TOKEN and MAPBOX_ACCESS_TOKEN for MapBox access. Please follow the quick start tutorial on the Mapbox developer portal here: https://docs.mapbox.com/android/maps/guides/install/

MAPS_API_KEY for GoogleMap access. Please follow the quick start tutorial on the Mapbox developer portal here: https://developers.google.com/maps/documentation/android-sdk/start

Samples


Project

API Wrapper Sample

A sample showing how we use what3words Android Wrapper library in autosuggest textfield search and voice search.

• Convert from coordinate to 3 words address
• Convert from 3 words to coordinate
• Search by 3 words
• Voice search 3 words

The library used: w3w-android-wrapper

More information

API Wrapper sample demo

AutoSuggest Sample

A sample showing how we using what3words Components autosuggest textfield in compose and xml.

• Using Autosuggestion textfield component in compose/xml
• Customize voice search layout
• Customize picker, error message view
• Config result output by language, clip to country, etc..
• Config validation input

The library used: w3w-android-components

More information

API Wrapper sample demo

AutoSuggest Voice Sample

A sample voice only showing how we using what3words Components voice and how we customize the voice search.

• Customize the result output by voice language
• Config return result coordinate
• Config result output by language, clip to country, etc..

The library used: w3w-android-components, w3w-android-wrapper

More information

API Wrapper sample demo

Mapbox Sample

This is a sample show how using the what3words Map Component provides a straightforward way to add what3words to a Mapbox map and display features such as the what3words grid and what3words markers with what3words address.

• Display the what3words grid on the top of the basemap
• Display mapbox map with what3words Map Component
• Display what3words markers

The library used: w3w-android-map-components

More information

API Wrapper sample demo

Google Map Sample

This is a sample show how using the what3words Map Component provides a straightforward way to add what3words to a Google Map and display features such as the what3words grid and what3words markers with what3words address.

• Display the what3words grid on the top of the basemap
• Display google map with what3words Map Component
• Display what3words markers

The library used: w3w-android-map-components

More information

API Wrapper sample demo

OCR Sample

This is a sample show how using the what3words OCR Component to detect 3 words adrress

• Launch OCR scanner in screen
• Launch OCR scanner as pop up
• Config language for detection

The library used: w3w-android-ocr-components

More information

API Wrapper sample demo

Multi-Component Sample

A sample combines fully what3words components such as autosuggest text filed, voice, map, and OCR scanner to demonstrate full flow how using in the real case by showing feature searching by a text field, voice, OCR scan and prepopulate to map.

• Integrate autosuggest textfiled with voice search
• Integrate map component for GoogleMap and Mapbox
• Integrate the OCR scanner

The library used: w3w-android-wrapper, w3w-android-map-components, w3w-android-ocr-components

More information

API Wrapper sample demo

Full what3words library repositories:

Name Repository
w3w-android-wrapper https://github.com/what3words/w3w-android-wrapper
w3w-android-components https://github.com/what3words/w3w-android-components
w3w-android-map-components https://github.com/what3words/w3w-android-map-components
w3w-android-ocr-components https://github.com/what3words/w3w-android-ocr-components