Places API Reference

Contents

UI API

 
nokia

Data API

 
nokia

jsMotif

 
jsMotif

Namespace nokia.places.settings

Namespace Summary

This namespace provides functions that handle server and communication settings. Its public interface consists of a function that allows the developer to set the API access key and a function to set the locale (language) for the information retrieved from the Places back end.

Method Summary

setAppContext (params)
This function is used to set authentication token and app id.
setCategoryIconPath (path)
Set path to folder containing category icons
setLocale (locale)
This method sets the locale (language) for data api requests.

Field Summary

supportedLanguages Hash table of api UI supported languages

Method Detail

setAppContext (params)
This function is used to set authentication token and app id.
Parameters:
{Object} params
An object that must contain the followng attributes:
  • appId - a {String} containing the application id
  • authenticationToken - a {String} containing the authentication token for the application
setCategoryIconPath (path)
Set path to folder containing category icons
Parameters:
{String} path
to folder containing category icons
setLocale (locale)
This method sets the locale (language) for data api requests. It should be called prior to requesting data from the Places back end to retrieve places data in a non-default language.
Parameters:
{String} locale
A language designation composed of An ISO 369 lanuage code and an ISO 36166-1 Alpha-2 country code (for example 'cs-cz' stands for Czech as spoken in the Czech Republic; if not specified, the default language is used ('en-gb')

Field Detail

supportedLanguages
Hash table of api UI supported languages

Copyright © 2011 Nokia. All rights reserved. Terms and Conditions