AtlasCT.com
User Manual v5.0

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
The POIs constructor.
Saves a user's poi.
Saves a poi's category.
Execute a clustered search pois.
Deletes a user's poi.
Deletes a user's poi category.
Deletes a user's poi geometry.
Get current user poi's. This method initialize the poiList object.
Returns a requested poi's details. This method initialize the poi object.
Returns a list of all poi categories.
Remove the poi category icon.
Removes the poi icon.
Searches for pois by location, search text or poi category.
Sets a poi icon - saves a url link to an external icon (icon that is not uploaded to the media server).
Sets a poi's location.
Updates a poi category.
Updates a poi details.
Updates a user's poi geometry.
The message from the LBS server.
The ResponseStatus object of the users which includes the results from the server.
The response text from the LBS server.
The cause name result that return from the LBS server.
An array that contains a list of the causes result that return from the LBS server.
The cause type result that return from the LBS server.
The result id that return from the LBS server.
Equal to resultId.
Category object.
An array that contains a list of Category objects.
Poi object.
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

storageIdThe storage id for this poi.
titleThe title for this poi.
tagsThe tags for this poi.
poiPermissionThe poi permission (0/1).
latLongThe latlong point for the poi.
descriptionThe description for this poi.
categoryCodeThe category code for this poi.
addressThe address(string) for this poi.
field1Custum field number 1.
field2Custum field number 2.
field3Custum field number 3.
geomTypeThe geometry type (POLYGON, POLYLINE, CIRCLE).
geomRadiusThe geometry radius.
geomPointsThe geometry points (only supported LatLong).
geomLineWidthThe geometry line width.
geomLineColorThe geometry line color.
geomFillColorThe geometry fill color.

See Also

deletePoi

addPoiCategory

addPoiCategory( boolean categoryPermission
string categoryUsage
string description
string minZoomLevel)

Saves a poi's category.

Parameters

categoryPermissionSets category permission (0=public, 1=private).
categoryUsageSets the category usage of the poi category (OPEN/CLOSED).
descriptionThe description for the poi category.
minZoomLevelSets the minimum zoom level for the poi category.

See Also

deletePoiCategory

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

categoryCodesSets category's codes for the search.
latLongSets the latlong point for the search.
heightSets the height for the search.
widthSets the width for the search.
zoomLevelSets the zoom level for the search.
iconFormatSets the icon format for the results.
langSets the language for the results.
resultsInSquareSets the results in square for the results.
squareSizeSets the square size for the results.
searchTextThe query.
thumbHeightSets the thumb height for the results.
thumbWidthSets the thumb width for the results.

deletePoi

deletePoi( string storageId
string poiId)

Deletes a user's poi.

Parameters

storageIdThe storage id for this poi.
poiIdThe poi id.

See Also

addPoi

deletePoiCategory

deletePoiCategory( string categoryCode)

Deletes a user's poi category.

Parameters

categoryCodeThe category code.

See Also

addPoiCategory

deletePoiGeometry

deletePoiGeometry( string storageId
string poiId)

Deletes a user's poi geometry.

Parameters

storageIdThe storage id for this poi.
poiIdThe 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

storageIdThe storage id.
thumbHeightSets the thumb height for the results.
thumbWidthSets the thumb width for the results.
categoryCodesSets category's codes for the results.
pageNumberWhich page number to get.
rowsInPageHow much rows in page?

See Also

getPoi

getPoi

getPoi( string storageId
string poiId
integer thumbHeight
integer thumbWidth)

Returns a requested poi's details. This method initialize the Poi object.

Parameters

storageIdThe storage id.
poiIdThe poi id.
thumbHeightSets the thumb height for the results.
thumbWidthSets the thumb width for the results.

See Also

getMyPois

getPoiCategories

getPoiCategories( boolean excludeGenerics)

Returns a list of all poi categories.

Parameters

excludeGenericsExclude generics categories? (boolean, default is false)

removePoiCategoryIcon

removePoiCategoryIcon( string categoryCode)

Remove the poi category icon.

Parameters

categoryCodeThe category icon.

removePoiIcon

removePoiIcon( string storageId
string poiId)

Removes the poi icon.

Parameters

storageIdThe storage id.
poiIdThe 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

categoryCodesSets category's codes for the search.
latLongSets the latlong point for the search.
radiusThe radius to search in.
searchTextThe query.
thumbHeightSets the thumb height for the results.
thumbWidthSets 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

storageIdThe storage id.
poiIdThe poi id.
iconUrlThe url for the icon.

setPoiLocation

setPoiLocation( string storageId
string poiId
LatLong latLong)

Sets a poi's location.

Parameters

storageIdThe storage id.
poiIdThe poi id.
latLongSets the latlong point for the poi location.

updatePoiCategory

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

Updates a poi category.

Parameters

categoryPermissionSets category permission (0=public, 1=private).
categoryUsageSets the category usage of the poi category (OPEN/CLOSED).
descriptionThe description for this poi category.
minZoomLevelSets the minimum zoom level for the poi category.
categoryCodeThe 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

storageIdThe storage id for this poi.
titleThe title for this poi.
tagsThe tags for this poi.
poiPermissionThe poi permission (0/1).
latLongThe latlong point for the poi.
descriptionThe description for this poi.
categoryCodeThe category code for this poi.
field1Custum field number 1.
field2Custum field number 2.
field3Custum field number 3.
addressThe address(string) for this poi.
poiIdThe poi id.

See Also

addPoi

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

storageIdThe storage id for this poi geometry.
poiIdThe poi id.
geomTypeThe geometry type (POLYGON, POLYLINE, CIRCLE).
geomRadiusThe geometry radius.
geomPointsThe geometry points (only supported LatLong).
geomLineWidthThe geometry line width.
geomLineColorThe geometry line color.
geomFillColorThe geometry fill color.

See Also

addPoi

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.

category

Category category

Category object.

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.