Table of Contents
About #
This is the workhorse class of the GraffitiW3W implementation. It handles all communication with the API.
Enumerations #
This object exposes no enumerations.
Constants #
This object exposes no constants.
Events #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| Completed | point as GraffitiW3W.MapPoint words as String | None | This event is raised when a query has been successfully resolved. |
| Error | responseCode as Integer errorCode as String errorMessage as String | None | An error occurred while performing a query. In many cases, the parameter values are passed directly from the W3W API response. A response code of 1 indicates that the service was successfully contacted but reported an error. Other response codes are likely to be HTTP status codes. |
| SuggestionAvailable | results() as GraffitiW3W.Suggestion | None | This even is raised when a query to get suggestions for a three word value has completed successfully. |
Methods #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| FromCoordinates | point as GraffitiW3W.MapPoint | None | Begins an asynchronous query to get a point from a three word value from a set of map coordinates. |
| FromCoordinates | point as GraffitiW3W.MapPoint | String | Performs a synchronous API call to resolve a map point to a three word value. This is the recommended method for Web applications. |
| GetSuggestions | forWords as GraffitiW3W.AutoSuggest | None | Begins an asynchronous query to get suggestions for a supplied three word value. |
| GetSuggestions | forWords as GraffitiW3W.AutoSuggest | GraffitiW3W.Suggestion | Performs a synchronous query to get a suggestion for a three word value. This is the recommended method for Web applications. |
| ToCoordinates | words as String | None | Begins an asynchronous query to resolve a three words value to a set of map coordinates. |
| ToCoordinates | words as String | GraffitiW3W.MapPoint | Performs a synchronous query to resolve a three words values to a set of map coordinates. This is the recommended method for Web applications. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| Language | GraffitiW3W.Language | SystemLanguage | The language which queried three words values and results should be. Override as needed. |