Places API Reference

Contents

UI API

 
nokia

Data API

 
nokia

jsMotif

 
jsMotif

Namespace nokia.places.APIFunctions

Namespace Summary

The namespace APIFunction defines functions that populate HTML elements in a template with data when the template is rendered. The functions must be invoked from the value of the element attribute fill, for example: fill="getFullAddress()".

Method Summary

country (jsonObject) : String
This function retrieves the country name from the place address from the JSON object supplied by the caller.
fullAddress (jsonObject) : String
This function retrieves the complete formatted address of a place from the JSON object supplied by the caller.
isPlace (jsonObject) : Boolean
This function checks if an object supplied by the caller is a place.
locality (jsonObject) : String
This function retrieves the part of the place address including zip/post code, city, state and country, if available, from the JSON object supplied by the caller.
primaryDescriptions (jsonObject) : Object
This function returns an array of up to five descriptions with the most content available from the JSON object supplied by the caller.
primaryEmail (jsonObject) : String
This function retreives the primary email number for a place from the JSON object supplied by the caller.
primaryFax (jsonObject) : String
This function retrieves the primary fax number of a place, if available, from the JSON object supplied by the caller.
primaryMobile (jsonObject) : String
This function returns the primary mobile phone number for a place from the JSON object supplied by the caller.
primaryPhone (jsonObject) : String
This function retrieves the primary phone number for a place, if available in the JSON object supplied by the caller.
primaryURL (jsonObject) : String
This function retrieves the primary Web site URL for a place, if available in the JSON object supplied by the caller.
primaryURLLabel (jsonObject)
This function retrieves the primary Web site label associated with a place from the JSON object supplied by the caller.
reviewDate (jsonObject)
This function retrieves a date formatted appropriately for the locale from the JSON object supplied by the caller.
street (jsonObject) : String
This function retrieves the street address of a place (partial place address, without city, state and country) from the JSON object supplied by the caller.

Method Detail

country (jsonObject) : String
This function retrieves the country name from the place address from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the country name
fullAddress (jsonObject) : String
This function retrieves the complete formatted address of a place from the JSON object supplied by the caller. The format follows the pattern: full street name + zip/post code + city + country.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the full address
isPlace (jsonObject) : Boolean
This function checks if an object supplied by the caller is a place.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object to check
Returns:
{Boolean}
true if the supplied object is a valid instance of {nokia.places.objects.Place}, otherwise false
locality (jsonObject) : String
This function retrieves the part of the place address including zip/post code, city, state and country, if available, from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing part of the place address including zip/post code, city, state and country
primaryDescriptions (jsonObject) : Object
This function returns an array of up to five descriptions with the most content available from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{Object}
An array of retrieved description items (nokia.places.objects.Place.editorials)
primaryEmail (jsonObject) : String
This function retreives the primary email number for a place from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the primary e-mail address
primaryFax (jsonObject) : String
This function retrieves the primary fax number of a place, if available, from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the primary fax number
primaryMobile (jsonObject) : String
This function returns the primary mobile phone number for a place from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the primary mobile phone number
primaryPhone (jsonObject) : String
This function retrieves the primary phone number for a place, if available in the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string contianing the primary phone number
primaryURL (jsonObject) : String
This function retrieves the primary Web site URL for a place, if available in the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the primary URL
primaryURLLabel (jsonObject)
This function retrieves the primary Web site label associated with a place from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
A {String} containing the primary Web site URL, or, if the URL is longer than 25 characters, the 'Website' string
reviewDate (jsonObject)
This function retrieves a date formatted appropriately for the locale from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Review} jsonObject
A review object
Returns:
A {String} containing a formatted date
street (jsonObject) : String
This function retrieves the street address of a place (partial place address, without city, state and country) from the JSON object supplied by the caller.
Parameters:
{nokia.places.objects.Place} jsonObject
A place object
Returns:
{String}
A string containing the street address

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