Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

OptionDefaultValuesDescription
keyNo defaultStringThe Custom Key.
isTrialtruetrue, falseDetermines if executing Global Address Complete against our trial or live environment.
setBiasToIP

false

true, falseSets the starting location from which results should be return from to the IP location of the user so that if you are in Santa Barbara, CA, USA as you type suggested addresses returned are first from there.
setCountryByIPfalsetrue, falseSets the country selected to the country of the user.
countriesNo default

Various country

values

Limits the suggestions to by country, for example this can be added to the options to restrict suggestions to Canada, Russia and Sweden:

countries: { codesList:"CAN, RUS, SWE"}

Validatetruetrue,falseSets the selected United States addresses to return validated against our DOTS Address Validation US - 3 Service.
cultureen_USVarious valuesCulture can be provided as an option and can be entered in the form of the two letter ISO code or the culture name: "en_US", "fr_FR", "fr_CA"
languagePreferenceenVariousTwo letter ISO codes for the language preferred.
promptfalsetrue, falseTurn on additional prompts based on conditions of the suggestions, such as: "No Results Found" or "Keep Typing..."
maxItems7Integer

The maximum number of items to return in the dropdown.

DoPlacefalsetrue, falseSetting this option to "true" will set the component to do place predict suggestions instead of address
SearchTypeLocalityLocality only but will vary in the futureDetermines the Global Address Complete Search Type if specified. If using the Address Search Type, no need to include this field. If a value is placed that does not match with Locality, it will return empty results. More Search Type options coming soon.


*Note, the true/false values are boolean values and not strings.