Maps SDK for Web

Class CopyrightCaption

The copyright caption service implementation. Provides a caption that is supposed to be display on link providing to full copyright notice. The response is not changed often.

This service is supposed to be called once when user have the map displayed for the first time.

Parameters can be passed to the constructor or provided via convenient methods that can be chained until the method go performs the actual call.

The call is asynchronous therefore the user have two options for receive the response:

  • Passing a callback function.
  • Use the Promise returned by the go method to handle the response.

Constructor

CopyrightCaption([options])

Parameters
Name Description Required Type/Values Default
options No Object None
options.key This is optional if a key was already defined globally No String None
options.protocol Protocol's type No "http" | "https" "https"
options.callback Callback function to use in case of success No Function None
options.fail Callback function to use in case of failure No Function default
Example
tomtom.copyrightCaption()
  .go()
  .then(function(response) {
    console.log(response);
  });

Methods

callback([newValue]): Function Chainable

Sets or gets the value of the option callback. This callback function will be called only after the go method successfully complete its task. Its first and unique argument passed to the callback will be the result of the request.

Parameters
Name Description Required Type/Values Default
newValue The new callback function No Function None
Throws

If the given argument is not a function

Returns

The same service instance or the current callback function if no argument was given

Example
function callbackFn(results) {
  console.log(results);
}
tomtom.fuzzySearch()
  .query("pizza")
  .callback(callbackFn)
  .go();

fail([newValue]): Function Chainable

Sets or gets the value of the option fail. This function is called when an error occurs (e.g. invalid values or a communication error). The callback will receive just one argument which is the error description. This parameter will be ignored if the callback function is not defined and therefore the go method will return a Promise that will be rejected if an error occurs. If you don't specificy a failure callback, the default behavior in case of encounter a problem is to throw an error.

Parameters
Name Description Required Type/Values Default
newValue The new callback function No Function None
Throws

If the given argument is not a function

Returns

The same service instance or the current callback function if no argument was given

Example
function successCallback(results) {
  console.log(results);
}
function failureCallback(error) {
  console.log(error);
}
tomtom.fuzzySearch()
  .query("pizza")
  .callback(successCallback)
  .fail(failureCallback)
  .go();

go([success], [fail]): Promise | Null

Perform the actual call to the web service.

It receives two optional arguments. The first one is a callback function that will be used when a successful response if received by the web service. The second one is another callback function that will be used only in case of failure.

Both arguments are shortcuts for the callback and fail methods respectively.

The final response from service is a string containing the caption i.e.: © 1992 - 2016 TomTom.

This text have to be displayed as a copyright prompt when using TomTom services. The caption should be clickable. User should be presented with full copyright notice when caption is clicked. For further documentation please check the caption class.

The SDK provides a Promise polyfill for browsers (IE<9) without native ECMAScript 6 support.

Parameters
Name Description Required Type/Values Default
success The callback function to be called on case of success. No Function None
fail The callback function to be called on case of failure. If a success callback is not given this argument will be ignored. In that case the returned Promise should be used to handle the failures. No Function None
Returns

If the success callback is omitted (and wasn't defined one yet) this function will return a Promise

key([newValue]): String Chainable

Sets or returns the API key to be used in calls made by this service instance. Setting a key for each instance of this class is not needed if the key was already setted globally using the tomtom.searchKey() function. A valid API key is required to make use of the Search API services. It can be issued from TomTom's Developer Portal.

Parameters
Name Description Required Type/Values Default
newValue key API Key valid for requested service No String None
Throws

If the given argument cannot be converted to a valid value

Returns

The same service instance or the current option value if no argument was given

protocol([newValue]): String Chainable

Sets or returns the protocol option value to be used in the calls. Represents the type of protocol used to perform service call.

Parameters
Name Description Required Type/Values Default
newValue Protocol type No "http" | "https" None
Throws

If the given argument cannot be converted to a valid value

Returns

The same service instance or the current option value if no argument was given