This is the what3words Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:17:11 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
what3wordsDescribe what3words here
Martin R. Enders
BSD
drakma (system).
jsown (system).
cl-ppcre (system).
package.lisp (file).
what3words.lisp (file).
what3words-test.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
what3words/what3words.asdwhat3words/package.lispwhat3words/what3words.lispwhat3words/what3words-test.lispwhat3words/what3words.lisppackage.lisp (file).
what3words (system).
*key* (special variable).
data (reader method).
get-languages (function).
position-to-three-words (function).
text (reader method).
three-words-to-position (function).
w3w-api-error (condition).
*get-languages-url* (special variable).
*position-url* (special variable).
*w3w-url* (special variable).
create-return-data (function).
ensure-json-key (function).
get-api-status (function).
handle-w3w-error-status (function).
w3w-error-p (function).
w3w-to-list (function).
what3words/what3words-test.lispwhat3words.lisp (file).
what3words (system).
test (function).
Packages are listed by definition order.
what3wordscommon-lisp.
*key* (special variable).
data (generic reader).
get-languages (function).
position-to-three-words (function).
text (generic reader).
three-words-to-position (function).
w3w-api-error (condition).
*get-languages-url* (special variable).
*position-url* (special variable).
*w3w-url* (special variable).
create-return-data (function).
ensure-json-key (function).
get-api-status (function).
handle-w3w-error-status (function).
w3w-error-p (function).
w3w-to-list (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
codes-only: if true return a list of language codes, if nil return a-list of language-codes and language-names
key: api-key
raise-error: if true raise an error if one occurs, if nil then return nil and the errormessage from w3w as multiple return values
latitude: latitude in degrees
longitude: longitude in degrees
language: nil for default language or language-code (see get-languages function)
corners: true for the coordinates of the w3w square, false for the southwest and northeast coordinates of the square
key: api-key
multiple-return-values: three words (list), position (list), language (language-code, string), corners (positions of southwest and northeast corners or nil) raise-error: if true raise an error if one occurs, if nil then return nil and the errormessage from w3w as multiple return values
three-words: list of three words or string of three words with dots ‘.‘
language: nil for default language or language-code (see get-languages function); use only if you want to return 3 words in a different language then the language to the language submitted (can be used for translation of ’3 words’
corners: true for the coordinates of the w3w square, false for the southwest and northeast coordinates of the square
key: api-key
multiple-return-values: three words (list), position (list), type(string) language (language-code, string), corners (positions of southwest and northeast corners or nil)
raise-error: if true raise an error if one occurs, if nil then return nil and the errormessage from w3w as multiple return values
w3w-api-error)) ¶data.
w3w-api-error)) ¶text.
error.
Create returndata for the exported functions from the parsed json objects
The structure of the status within the response from w3w is not always the same
raise or return error message from w3w API
Check status from w3w api
Convert What 3 Words dot notation to list
| Jump to: | C D E F G H M P T W |
|---|
| Jump to: | C D E F G H M P T W |
|---|
| Jump to: | *
D S T |
|---|
| Jump to: | *
D S T |
|---|
| Jump to: | C F P S W |
|---|
| Jump to: | C F P S W |
|---|