POIs

Enable users to generate their own POIs (points of interest), and share them with other users of the application.
This class is not part of the basic SDK.
In order to use this class you must get an application id from AtlasCT.

Summary

POIs
Constructors
POIs	The POIs constructor.
Methods
addPoi	Saves a user's poi.
addPoiCategory	Saves a poi's category.
clusteredSearchPois	Execute a clustered search pois.
deletePoi	Deletes a user's poi.
deletePoiCategory	Deletes a user's poi category.
deletePoiGeometry	Deletes a user's poi geometry.
getMyPois	Get current user poi's. This method initialize the poiList object.
getPoi	Returns a requested poi's details. This method initialize the poi object.
getPoiCategories	Returns a list of all poi categories.
removePoiCategoryIcon	Remove the poi category icon.
removePoiIcon	Removes the poi icon.
searchPois	Searches for pois by location, search text or poi category.
setPoiExternalIcon	Sets a poi icon - saves a url link to an external icon (icon that is not uploaded to the media server).
setPoiLocation	Sets a poi's location.
updatePoiCategory	Updates a poi category.
updatePoiDetails	Updates a poi details.
updatePoiGeometry	Updates a user's poi geometry.
Properties
responseMessage	The message from the LBS server.
responseStatus	The ResponseStatus object of the users which includes the results from the server.
responseText	The response text from the LBS server.
resultCauseName	The cause name result that return from the LBS server.
resultCausesList	An array that contains a list of the causes result that return from the LBS server.
resultCauseType	The cause type result that return from the LBS server.
resultId	The result id that return from the LBS server.
resultStatusCode	Equal to resultId.
category	Category object.
categoryList	An array that contains a list of Category objects.
poi	Poi object.
poiList	An array that contains a list of Poi objects.

Constructors

POIs

POIs()

The POIs constructor.

Methods

addPoi

addPoi( string storageId
string title
string tags
boolean poiPermission
LatLong latLong
string description
string categoryCode
string address
string field1
string field2
string field3
string geomType
string geomRadius
string geomPoints
string geomLineWidth
string geomLineColor
string geomFillColor )

Saves a user's poi.

Parameters

storageId	The storage id for this poi.
title	The title for this poi.
tags	The tags for this poi.
poiPermission	The poi permission (0/1).
latLong	The latlong point for the poi.
description	The description for this poi.
categoryCode	The category code for this poi.
address	The address(string) for this poi.
field1	Custum field number 1.
field2	Custum field number 2.
field3	Custum field number 3.
geomType	The geometry type (POLYGON, POLYLINE, CIRCLE).
geomRadius	The geometry radius.
geomPoints	The geometry points (only supported LatLong).
geomLineWidth	The geometry line width.
geomLineColor	The geometry line color.
geomFillColor	The geometry fill color.

addPoiCategory

addPoiCategory( boolean categoryPermission
string categoryUsage
string description
string minZoomLevel )

Saves a poi's category.

Parameters

categoryPermission	Sets category permission (0=public, 1=private).
categoryUsage	Sets the category usage of the poi category (OPEN/CLOSED).
description	The description for the poi category.
minZoomLevel	Sets the minimum zoom level for the poi category.

clusteredSearchPois

clusteredSearchPois( boolean categoryCodes
LatLong latLong
integer height
integer width
string zoomLevel
string iconFormat
string lang
integer resultsInSquare
integer squareSize
string searchText
integer thumbHeight
integer thumbWidth )

Execute a clustered search pois.

Parameters

categoryCodes	Sets category's codes for the search.
latLong	Sets the latlong point for the search.
height	Sets the height for the search.
width	Sets the width for the search.
zoomLevel	Sets the zoom level for the search.
iconFormat	Sets the icon format for the results.
lang	Sets the language for the results.
resultsInSquare	Sets the results in square for the results.
squareSize	Sets the square size for the results.
searchText	The query.
thumbHeight	Sets the thumb height for the results.
thumbWidth	Sets the thumb width for the results.

deletePoi

deletePoi( string storageId
string poiId )

Deletes a user's poi.

Parameters

storageId	The storage id for this poi.
poiId	The poi id.

deletePoiCategory

deletePoiCategory( string categoryCode )

Deletes a user's poi category.

Parameters

categoryCode

The category code.

deletePoiGeometry

deletePoiGeometry( string storageId
string poiId )

Deletes a user's poi geometry.

Parameters

storageId	The storage id for this poi.
poiId	The poi id.

getMyPois

getMyPois( string storageId
integer thumbHeight
integer thumbWidth
string categoryCodes
integer pageNumber
integer rowsInPage )

Get current user poi's. This method initialize the poiList object.

Parameters

storageId	The storage id.
thumbHeight	Sets the thumb height for the results.
thumbWidth	Sets the thumb width for the results.
categoryCodes	Sets category's codes for the results.
pageNumber	Which page number to get.
rowsInPage	How much rows in page?

Parameters

storageId	The storage id.
poiId	The poi id.
thumbHeight	Sets the thumb height for the results.
thumbWidth	Sets the thumb width for the results.

getPoiCategories

getPoiCategories( boolean excludeGenerics )

Returns a list of all poi categories.

Parameters

excludeGenerics

Exclude generics categories? (boolean, default is false)

removePoiCategoryIcon

removePoiCategoryIcon( string categoryCode )

Remove the poi category icon.

Parameters

categoryCode

The category icon.

removePoiIcon

removePoiIcon( string storageId
string poiId )

Removes the poi icon.

Parameters

storageId	The storage id.
poiId	The poi id.

searchPois

searchPois( string categoryCodes
LatLong latLong
string radius
string searchText
integer thumbHeight
integer thumbWidth )

Searches for pois by location, search text or poi category.

Parameters

categoryCodes	Sets category's codes for the search.
latLong	Sets the latlong point for the search.
radius	The radius to search in.
searchText	The query.
thumbHeight	Sets the thumb height for the results.
thumbWidth	Sets the thumb width for the results

setPoiExternalIcon

setPoiExternalIcon( string storageId
string poiId
string iconUrl )

Sets a poi icon - saves a url link to an external icon (icon that is not uploaded to the media server).

Parameters

storageId	The storage id.
poiId	The poi id.
iconUrl	The url for the icon.

setPoiLocation

setPoiLocation( string storageId
string poiId
LatLong latLong )

Sets a poi's location.

Parameters

storageId	The storage id.
poiId	The poi id.
latLong	Sets the latlong point for the poi location.

updatePoiCategory

updatePoiCategory( boolean categoryPermission
string categoryUsage
string description
string minZoomLevel
string categoryCode )

Updates a poi category.

Parameters

categoryPermission	Sets category permission (0=public, 1=private).
categoryUsage	Sets the category usage of the poi category (OPEN/CLOSED).
description	The description for this poi category.
minZoomLevel	Sets the minimum zoom level for the poi category.
categoryCode	The category code for this poi category.

updatePoiDetails

updatePoiDetails( string storageId
string title
string tags
boolean poiPermission
LatLong latLong
string description
string categoryCode
string field1
string field2
string field3
string address
string poiId )

Updates a poi details.

Parameters

storageId	The storage id for this poi.
title	The title for this poi.
tags	The tags for this poi.
poiPermission	The poi permission (0/1).
latLong	The latlong point for the poi.
description	The description for this poi.
categoryCode	The category code for this poi.
field1	Custum field number 1.
field2	Custum field number 2.
field3	Custum field number 3.
address	The address(string) for this poi.
poiId	The poi id.

updatePoiGeometry

updatePoiGeometry( string storageId
string poiId
string geomType
string geomRadius
string geomPoints
string geomLineWidth
string geomLineColor
string geomFillColor )

Updates a user's poi geometry.

Parameters

storageId	The storage id for this poi geometry.
poiId	The poi id.
geomType	The geometry type (POLYGON, POLYLINE, CIRCLE).
geomRadius	The geometry radius.
geomPoints	The geometry points (only supported LatLong).
geomLineWidth	The geometry line width.
geomLineColor	The geometry line color.
geomFillColor	The geometry fill color.

Properties

responseMessage

string responseMessage

The message from the LBS server.

responseStatus

ResponseStatus responseStatus

The ResponseStatus object of the users which includes the results from the server.

responseText

string responseText

The response text from the LBS server.

resultCauseName

string resultCauseName

The cause name result that return from the LBS server.

resultCausesList

Array[] resultCausesList

An array that contains a list of the causes result that return from the LBS server.

resultCauseType

string resultCauseType

The cause type result that return from the LBS server.

resultId

interger resultId

The result id that return from the LBS server.

resultStatusCode

interger resultStatusCode

Equal to resultId.

categoryList

Array[] categoryList

An array that contains a list of Category objects.

poi

Poi poi

Poi object.

poiList

Array[] poiList

An array that contains a list of Poi objects.

The EventListener class helps you to register event handlers defined by this API.
Some of the classes that inherit from this class are: Map, OverviewMap, LayersManager

Geocode()

The Geocode constructor.

find(Address address)

Convert an address to geographical location.

coordinateToAddress(Coordinate coordinate)

Convert a geographical location to an address.

An integer that contains the search result code.

An Address object that contains the geocode response address.

An array that contains a list of addresses that matching the requested address/coordinate.

This event dispatches after a geocode response has arrived from the server.

The Address class represent a specific address information, with its coordinates.

This is the base class of the provided coordinates classes.

POIs

Constructors

POIs

Methods

addPoi

Parameters

See Also

addPoiCategory

Parameters

See Also

clusteredSearchPois

Parameters

deletePoi

Parameters

See Also

deletePoiCategory

Parameters

See Also

deletePoiGeometry

Parameters

getMyPois

Parameters

See Also

getPoi

Parameters

See Also

getPoiCategories

Parameters

removePoiCategoryIcon

Parameters

removePoiIcon

Parameters

searchPois

Parameters

setPoiExternalIcon

Parameters

setPoiLocation

Parameters

updatePoiCategory

Parameters

updatePoiDetails

Parameters

See Also

updatePoiGeometry

Parameters

See Also

Properties

responseMessage

responseStatus

responseText

resultCauseName

resultCausesList

resultCauseType

resultId

resultStatusCode

category

categoryList

poi

poiList