
public final class Point
extends GeoData

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Point.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Location`	`location`
`private GeocachingData`	`gcData`
`private ByteArray`	`gcDataBinary`
`private final String`	`extraCallback`
`private final String`	`extraOnDisplay`
`private Long`	`id`
`private String`	`name`
`private Long`	`timeCreated`
`private Long`	`timeUpdated`
`private GeoDataExtra`	`extraData`
`private GeoDataStyle`	`styleNormal`
`private GeoDataStyle`	`styleHighlight`
`private GeoData.Privacy`	`privacy`
`private Boolean`	`protected`
`private Boolean`	`isEnabled`
`private Boolean`	`isVisible`
`private Boolean`	`isSelected`
`private ByteArray`	`extraDataRaw`
`private Byte`	`parameterSource`
`private String`	`parameterStyleName`
`private String`	`parameterDescription`
`private PointRteAction`	`parameterRteAction`
`private final Integer`	`paramRteIndex`
`private ByteArray`	`styles`
`private final Storable`	`copy`
`private final ByteArray`	`asBytes`

Constructor Summary

Constructors
Constructor	Description
`Point(String name, Location loc)`	Create point with known name and it's location.
`Point()`

Method Summary

Modifier and Type	Method	Description
`final Location`	`getLocation()`	Location of current point.
`final Unit`	`setLocation(Location location)`	Location of current point.
`final GeocachingData`	`getGcData()`	Additional geoCaching data.
`final Unit`	`setGcData(GeocachingData gcData)`	Additional geoCaching data.
`final ByteArray`	`getGcDataBinary()`
`final Unit`	`setGcDataBinary(ByteArray gcDataBinary)`
`final String`	`getExtraCallback()`
`final String`	`getExtraOnDisplay()`
`final Long`	`getId()`	Unique ID of this object.
`final Unit`	`setId(Long id)`	Unique ID of this object.
`final String`	`getName()`	Name of object, have to be unique
`final Unit`	`setName(String name)`	Name of object, have to be unique
`final Long`	`getTimeCreated()`	Time the data was created (ms).
`final Unit`	`setTimeCreated(Long timeCreated)`	Time the data was created (ms).
`final Long`	`getTimeUpdated()`	Time the data was updated for the last time (ms).
`final Unit`	`setTimeUpdated(Long timeUpdated)`	Time the data was updated for the last time (ms).
`final GeoDataExtra`	`getExtraData()`	Extra data with parameters.
`final Unit`	`setExtraData(GeoDataExtra extraData)`	Extra data with parameters.
`final GeoDataStyle`	`getStyleNormal()`	Style for normal state.
`final Unit`	`setStyleNormal(GeoDataStyle styleNormal)`	Style for normal state.
`final GeoDataStyle`	`getStyleHighlight()`	Style for highlight state.
`final Unit`	`setStyleHighlight(GeoDataStyle styleHighlight)`	Style for highlight state.
`final GeoData.Privacy`	`getPrivacy()`	Define item privacy mode.
`final Unit`	`setPrivacy(GeoData.Privacy privacy)`	Define item privacy mode.
`final Boolean`	`getProtected()`	Define read-write mode of item.
`final Unit`	`setProtected(Boolean protected)`	Define read-write mode of item.
`final Boolean`	`getIsEnabled()`
`final Unit`	`setIsEnabled(Boolean isEnabled)`
`final Boolean`	`getIsVisible()`
`final Unit`	`setIsVisible(Boolean isVisible)`
`final Boolean`	`getIsSelected()`
`final Unit`	`setIsSelected(Boolean isSelected)`
`final ByteArray`	`getExtraDataRaw()`
`final Unit`	`setExtraDataRaw(ByteArray extraDataRaw)`
`final Byte`	`getParameterSource()`
`final Unit`	`setParameterSource(Byte parameterSource)`
`final String`	`getParameterStyleName()`
`final Unit`	`setParameterStyleName(String parameterStyleName)`
`final String`	`getParameterDescription()`
`final Unit`	`setParameterDescription(String parameterDescription)`
`final PointRteAction`	`getParameterRteAction()`
`final Unit`	`setParameterRteAction(PointRteAction parameterRteAction)`
`final Integer`	`getParamRteIndex()`
`final ByteArray`	`getStyles()`
`final Unit`	`setStyles(ByteArray styles)`
`final Storable`	`getCopy()`
`final ByteArray`	`getAsBytes()`
`final Unit`	`setExtraCallback(String btnName, String packageName, String className, String returnDataName, String returnDataValue)`	Simply allow set callback value on point.
`final Unit`	`removeExtraCallback()`	If you want to remove PAR_INTENT_EXTRA_CALLBACK parametr from Locus database, you need to send "clear" value in updated waypoint back to Locus.
`final Unit`	`setExtraOnDisplay(String packageName, String className, String returnDataName, String returnDataValue)`	Extra feature that allow to send to locus only partial point data.
`final Unit`	`removeExtraOnDisplay()`	If you want to remove PAR_INTENT_EXTRA_ON_DISPLAY parameter from Locus database, you need to send "clear" value in updated waypoint back to Locus.

Methods inherited from class locus.api.objects.geoData.Point
addAttachmentAudio, addAttachmentOther, addAttachmentPhoto, addAttachmentVideo, addEmail, addEmail, addParameter, addParameter, addParameter, addParameter, addParameterEmail, addParameterEmail, addParameterPhone, addParameterPhone, addParameterUrl, addParameterUrl, addPhone, addPhone, addUrl, addUrl, getParameter, getParameterRaw, getTag, getTag, getTagsKeys, hasParameter, hasParameterDescription, isParameterSource, removeParameter, removeParameterSource, removeParameterStyleName, setTag, setTag
Methods inherited from class locus.api.objects.geoData.GeoData
read, read, read, write
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - Point
```
Point(String name, Location loc)
```
 Create point with known name and it's location.
 - Point
```
Point()
```
- Method Detail
 - getLocation
```
 final Location getLocation()
```
 Location of current point.
 - setLocation
```
 final Unit setLocation(Location location)
```
 Location of current point.
 - getGcData
```
 final GeocachingData getGcData()
```
 Additional geoCaching data.
 - setGcData
```
 final Unit setGcData(GeocachingData gcData)
```
 Additional geoCaching data.
 - getGcDataBinary
```
 final ByteArray getGcDataBinary()
```
 - setGcDataBinary
```
 final Unit setGcDataBinary(ByteArray gcDataBinary)
```
 - getExtraCallback
```
 final String getExtraCallback()
```
 - getExtraOnDisplay
```
 final String getExtraOnDisplay()
```
 - getId
```
 final Long getId()
```
 Unique ID of this object.
 - setId
```
 final Unit setId(Long id)
```
 Unique ID of this object.
 - getName
```
 final String getName()
```
 Name of object, have to be unique
 - setName
```
 final Unit setName(String name)
```
 Name of object, have to be unique
 - getTimeCreated
```
 final Long getTimeCreated()
```
 Time the data was created (ms).
 - setTimeCreated
```
 final Unit setTimeCreated(Long timeCreated)
```
 Time the data was created (ms).
 - getTimeUpdated
```
 final Long getTimeUpdated()
```
 Time the data was updated for the last time (ms).
 - setTimeUpdated
```
 final Unit setTimeUpdated(Long timeUpdated)
```
 Time the data was updated for the last time (ms).
 - getExtraData
```
 final GeoDataExtra getExtraData()
```
 Extra data with parameters.
 - setExtraData
```
 final Unit setExtraData(GeoDataExtra extraData)
```
 Extra data with parameters.
 - getStyleNormal
```
 final GeoDataStyle getStyleNormal()
```
 Style for normal state.
 - setStyleNormal
```
 final Unit setStyleNormal(GeoDataStyle styleNormal)
```
 Style for normal state.
 - getStyleHighlight
```
 final GeoDataStyle getStyleHighlight()
```
 Style for highlight state.
 - setStyleHighlight
```
 final Unit setStyleHighlight(GeoDataStyle styleHighlight)
```
 Style for highlight state.
 - getPrivacy
```
 final GeoData.Privacy getPrivacy()
```
 Define item privacy mode.
 - setPrivacy
```
 final Unit setPrivacy(GeoData.Privacy privacy)
```
 Define item privacy mode.
 - getProtected
```
 final Boolean getProtected()
```
 Define read-write mode of item. Protected item should not be exported from the Locus World or shared publicly to any place out of Locus scope.
 - setProtected
```
 final Unit setProtected(Boolean protected)
```
 Define read-write mode of item. Protected item should not be exported from the Locus World or shared publicly to any place out of Locus scope.
 - getIsEnabled
```
 final Boolean getIsEnabled()
```
 - setIsEnabled
```
 final Unit setIsEnabled(Boolean isEnabled)
```
 - getIsVisible
```
 final Boolean getIsVisible()
```
 - setIsVisible
```
 final Unit setIsVisible(Boolean isVisible)
```
 - getIsSelected
```
 final Boolean getIsSelected()
```
 - setIsSelected
```
 final Unit setIsSelected(Boolean isSelected)
```
 - getExtraDataRaw
```
 final ByteArray getExtraDataRaw()
```
 - setExtraDataRaw
```
 final Unit setExtraDataRaw(ByteArray extraDataRaw)
```
 - getParameterSource
```
 final Byte getParameterSource()
```
 - setParameterSource
```
 final Unit setParameterSource(Byte parameterSource)
```
 - getParameterStyleName
```
 final String getParameterStyleName()
```
 - setParameterStyleName
```
 final Unit setParameterStyleName(String parameterStyleName)
```
 - getParameterDescription
```
 final String getParameterDescription()
```
 - setParameterDescription
```
 final Unit setParameterDescription(String parameterDescription)
```
 - getParameterRteAction
```
 final PointRteAction getParameterRteAction()
```
 - setParameterRteAction
```
 final Unit setParameterRteAction(PointRteAction parameterRteAction)
```
 - getParamRteIndex
```
 final Integer getParamRteIndex()
```
 - getStyles
```
 final ByteArray getStyles()
```
 - setStyles
```
 final Unit setStyles(ByteArray styles)
```
 - getCopy
```
 final Storable getCopy()
```
 - getAsBytes
```
 final ByteArray getAsBytes()
```
 - setExtraCallback
```
 final Unit setExtraCallback(String btnName, String packageName, String className, String returnDataName, String returnDataValue)
```
 Simply allow set callback value on point. This appear when you click on point and then under last button will be your button. Clicking on it, launch by you, defined intent Do not forget to set this http://developer.android.com/guide/topics/manifest/activity-element.html#exported to your activity, if you'll set callback to other then launcher activity
 
 Parameters:
 
 btnName - Name displayed on button
 
 packageName - this value is used for creating intent that will be called in callback (for example com.super.
 
 className - the name of the class inside of com.super.application that implements the component (for example com.super.application.
 
 returnDataName - String under which data will be stored.
 
 returnDataValue - String under which data will be stored.
 - removeExtraCallback
```
 final Unit removeExtraCallback()
```
 If you want to remove PAR_INTENT_EXTRA_CALLBACK parametr from Locus database, you need to send "clear" value in updated waypoint back to Locus. After that, Locus will remove this parameter from new stored point. Second alternative, how to remove this callback, is to send new waypoints with forceOverwrite parameter set to true, that will overwrite completely all data
 - setExtraOnDisplay
```
 final Unit setExtraOnDisplay(String packageName, String className, String returnDataName, String returnDataValue)
```
 Extra feature that allow to send to locus only partial point data. When you click on point (in time when small point dialog should appear), locus send intent to your app, you can then fill complete point and send it back to Locus. Clear and clever Do not forget to set this http://developer.android.com/guide/topics/manifest/activity-element.html#exported to your activity, if you'll set callback to other then launcher activity
 
 Parameters:
 
 packageName - this value is used for creating intent that will be called in callback (for example com.super.
 
 className - the name of the class inside of com.super.application that implements the component (for example com.super.application.
 
 returnDataName - String under which data will be stored.
 
 returnDataValue - value that will be received when you try to get data from received response
 - removeExtraOnDisplay
```
 final Unit removeExtraOnDisplay()
```
 If you want to remove PAR_INTENT_EXTRA_ON_DISPLAY parameter from Locus database, you need to send "clear" value in updated waypoint back to Locus. After that, Locus will remove this parameter from new stored point. Second alternative, how to remove this callback, is to send new waypoints with forceOverwrite parameter set to true, that will overwrite completely all data

Class Point

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class locus.api.objects.geoData.Point

Methods inherited from class locus.api.objects.geoData.GeoData

Methods inherited from class java.lang.Object

Constructor Detail

Point

Point

Method Detail

getLocation

setLocation

getGcData

setGcData

getGcDataBinary

setGcDataBinary

getExtraCallback

getExtraOnDisplay

getId

setId

getName

setName

getTimeCreated

setTimeCreated

getTimeUpdated

setTimeUpdated

getExtraData

setExtraData

getStyleNormal

setStyleNormal

getStyleHighlight

setStyleHighlight

getPrivacy

setPrivacy

getProtected

setProtected

getIsEnabled

setIsEnabled

getIsVisible

setIsVisible

getIsSelected

setIsSelected

getExtraDataRaw

setExtraDataRaw

getParameterSource

setParameterSource

getParameterStyleName

setParameterStyleName

getParameterDescription

setParameterDescription

getParameterRteAction

setParameterRteAction

getParamRteIndex

getStyles

setStyles

getCopy

getAsBytes

setExtraCallback

removeExtraCallback

setExtraOnDisplay

removeExtraOnDisplay