3.0.0 (21-01-2014) LocationInput = This interface offers functions that implement the location-input functionality of a navigation system GetVersion = This method returns the API version implemented by the server application version = struct(major,minor,micro,date) major = when the major version changes, then backward compatibility with previous releases is not granted minor = when the minor version changes, then backward compatibility with previous releases is granted, but something changed in the implementation of the API (e.g. new methods may have been added) micro = when the micro version changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications) date = release date (e.g. 21-06-2011) CreateLocationInput = This method creates a new location input and retrieves a handle sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value This error is generated if no more location input handles are available DeleteLocationInput = This method deletes a location input and its associated resources sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value This error is generated if an application tries to delete a location input handle that is not available GetSupportedAddressAttributes = This method retrieves the supported address attributes addressAttributesList = array[attribute] attribute = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,STATE,CITY,POSTAL_CODE,STREET,HOUSENUMBER,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) SetAddress = This method sets the address to start with for the LocationInput identified by the given handle sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value address = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range[-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range[-180:+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield SetSelectionCriterion = This method sets the selection criterion for the current speller, search input and the corresponding result-lists for the current session sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value selectionCriterion = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) Spell = This method sends the next spell input for the current session Note: when a spell is started the entries of the search are removed sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value inputString = last input character (UTF-8) (0x08(Backspace) for delete last character, 0x0D(Carriage Return) for delete entire input) maxWindowSize = maximum number of elements that should be returned as result Search = This method sends the search input for the current session Note: when a search is started the entries of the spell input are removed sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value inputString = contains the String, that is searched maxWindowSize = maximum number of elements that should be returned as result CurrentSelectionCriterion = This signal notifies the SelectionCriterion for the current speller input or search. Note: when no SelectionCriterion was set or an input was finished, the SelectionCriterion has the value INVALID locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value selectionCriterion = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) SearchStatus = This signal updates the search status of the specified session locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value statusValue = enum(INVALID,NOT_STARTED,SEARCHING,FINISHED, ... ) SpellResult = This signal notifies the result of the previous Spell method locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value uniqueString = unique string derived from spell input (i.e. including auto-completion if applicable) validCharacters = set of (UTF-8 encoded) characters valid for next input (unified in a single string). A Backspace(0x08) is returned if the input character passed to the Spell method was invalid fullMatch = flag indicating whether the value in UniqueCharacters is already a full match for an existing list entry RequestListUpdate = This method sends a request for more list elements for the current session sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value offset = starting offset of the newly requested list elements maxWindowSize = maximum number of elements that should be returned as result SearchResultList = This signal updates the address result list (e.g. after a Search/Spell/Scroll call) locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value totalSize = total size of the result list windowOffset = window offset within the complete list windowSize = size of the provided window resultListWindow = array[address] address = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range [-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range [-180:+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield SearchResultListSizeChanged = This signal updates the size of the address result list locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value totalSize = total size of the result list SelectEntry = This method triggers selection of a result list entry by index Note: the update of the input content will be notified in signal ContentUpdated sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value index = absolute list index of the entry to be selected GetEntry = This method synchronously gets the address for the given result list entry locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value index = list index of the entry to be returned address = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range[-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range[-180:+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield ContentUpdated = This signal updates the input content data for the specified session locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value guidable = flag indicating whether the current address is guidable availableSelectionCriteria = array of enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) Note: availableSelectionCriteria indicates the parts of the address that can be changed address = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range[-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range[-180:+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield ValidateAddress = This method validates an address from different sources than Navigation sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value inputAddress = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range[-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range[-180,+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield AddressValidationResult = This signal notifies the validation result of a former ValidateAddress call locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value validatedAddressList = array[validatedAddress] validatedAddress = array[attribute] attribute = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER,ROADSHIELDS, ... ) key = LATITUDE, value = value of type ´d´, that expresses the latitude in format %3.6f. Range[-90:+90]. Example: 48.70901 key = LONGITUDE, value = value of type ´d´, that expresses the longitude in format %3.6f. Range[-180:+180]. Example: 9.167898 key = ALTITUDE, value = value of type ´i´, that expresses the altitude in meters key = COUNTRY, value = value of type ´s´, that identifies the country name key = COUNTRYCODE, value = value of type ´s´, ISO 3166‐1 alpha 3 country code (upper case) key = CITY, value = value of type ´s´, that identifies the city name key = STREET, value = value of type ´s´, that identifies the street name key = ROAD_NUMBER, value = value of type ´s´, that identifies the road number key = HOUSENUMBER, value = value of type ´s´, that identifies the house number key = HOUSENAME, value = value of type ´s´, that identifies the house name key = CROSSING, value = value of type ´s´, that identifies the crossing key = DISTRICT, value = value of type ´s´, that identifies the district name key = PHONENUMBER, value = value of type ´s´, that identifies a phone number key = POINAME, value = value of type ´s´, that identifies a POI name key = ROADSHIELDS, value = value of type ´a(sa(is)s)´, that identifies a roadshield validationStatusList = array[validationStatus] validationStatus = array[item] item = tuple(key,value) key = enum(INVALID,LATITUDE,LONGITUDE,ALTITUDE,FULL_ADDRESS,COUNTRY,COUNTRYCODE,STATE,CITY,POSTAL_CODE,STREET,ROAD_NUMBER,HOUSENUMBER,HOUSENAME,CROSSING,DISTRICT,PHONENUMBER,POINAME,TOWNCENTER, ... ) value = enum(INVALID,OK,UNKNOWN,AMBIGUOUS,INCONSISTENT) ReverseGeocode = This method transforms a geocoordinate into an address Note: the update of the input content will be notified in signal ContentUpdated sessionHandle = Session handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value locationInputHandle = Location input handle. Range[0x0:0x7fffffff]. 0x0 is reserved as an invalid handle value coordinate = struct(lat,lon) lat = latitude in format %3.6f. Range[-90:+90]. Example: 48.053250 lon = longitude in format %3.6f. Range[-180:+180]. Example: 8.321000