Constructor Detail

• GeoData

  GeoData()

Method Detail

• 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()

• addParameter

   final Boolean addParameter(Integer paramId, String param)

  Add single parameter defined by it's ID into extraData container.

  Parameters:

  paramId - ID of parameter

  param - text value of parameter

• addParameter

   final Boolean addParameter(Integer paramId, ByteArray param)

  Add single parameter defined by it's ID into extraData container.

  Parameters:

  paramId - ID of parameter

  param - value of parameter

• addParameter

   final Boolean addParameter(Integer paramId, Integer value)

  Add single parameter defined by it's ID into extraData container.

  Parameters:

  paramId - ID of parameter

  value - value of parameter

• addParameter

   final Boolean addParameter(Integer paramId, Byte param)

  Add single parameter defined by it's ID into extraData container.

  Parameters:

  paramId - ID of parameter

  param - value of parameter

• getParameter

   final String getParameter(Integer paramId)

  Return parameter stored in extraData container.

  Parameters:

  paramId - ID of parameter

• getParameterRaw

   final ByteArray getParameterRaw(Integer paramId)

  Get parameter in raw original format.

  Parameters:

  paramId - ID of parameter

• hasParameter

   final Boolean hasParameter(Integer paramId)

  Check if current object has parameter defined by it's ID.

  Parameters:

  paramId - ID of parameter

• removeParameter

   final String removeParameter(Integer paramId)

  Remove parameter from storage.

  Parameters:

  paramId - ID of parameter

• addParameterEmail

  @JvmOverloads() final Boolean addParameterEmail(String email, String label)

  Add "email" to current object.

  Parameters:

  email - email to add

  label - (optional) label visible in the app

• addParameterEmail

  @JvmOverloads() final Boolean addParameterEmail(String email)

  Add "email" to current object.

  Parameters:

  email - email to add

• addParameterPhone

  @JvmOverloads() final Boolean addParameterPhone(String phone, String label)

  Add "phone" to current object.

  Parameters:

  phone - email to add

  label - (optional) label visible in the app

• addParameterPhone

  @JvmOverloads() final Boolean addParameterPhone(String phone)

  Add "phone" to current object.

  Parameters:

  phone - email to add

• addParameterUrl

  @JvmOverloads() final Boolean addParameterUrl(String url, String label)

  Add "url" to current object.

  Parameters:

  url - email to add

  label - (optional) label visible in the app

• addParameterUrl

  @JvmOverloads() final Boolean addParameterUrl(String url)

  Add "url" to current object.

  Parameters:

  url - email to add

• addAttachmentAudio

   final Boolean addAttachmentAudio(String uri)

  Add audio to current object.

  Parameters:

  uri - uri to add

• addAttachmentPhoto

   final Boolean addAttachmentPhoto(String uri)

  Add photo to current object.

  Parameters:

  uri - uri to add

• addAttachmentVideo

   final Boolean addAttachmentVideo(String uri)

  Add video to current object.

  Parameters:

  uri - uri to add

• addAttachmentOther

   final Boolean addAttachmentOther(String uri)

  Add other content to current object.

  Parameters:

  uri - uri to add

• addEmail

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterEmail(email, ""))) final Unit addEmail(String email)

• addEmail

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterEmail(email, label))) final Unit addEmail(String label, String email)

• addPhone

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterPhone(phone, ""))) final Unit addPhone(String phone)

• addPhone

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterPhone(phone, label))) final Unit addPhone(String label, String phone)

• addUrl

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterUrl(url, ""))) final Unit addUrl(String url)

• addUrl

  @Deprecated(message = , replaceWith = @ReplaceWith(imports = {}, expression = addParameterUrl(url, label))) final Unit addUrl(String label, String url)

• isParameterSource

   final Boolean isParameterSource(Byte expectedSource)

  Check if waypoint source parameter is equal to expected value.

  Parameters:

  expectedSource - source we are checking

• removeParameterSource

   final Unit removeParameterSource()

  Remove existing source parameter.

• removeParameterStyleName

   final Unit removeParameterStyleName()

• hasParameterDescription

   final Boolean hasParameterDescription()

  Check if item has description parameter.

• getTag

  @JvmOverloads() final Object getTag(String key)

  Get tag attached to object, defined by "key".

  Parameters:

  key - key value that defined object

• getTag

  @JvmOverloads() final Object getTag()

  Get tag attached to object, defined by "key".

• setTag

   final Unit setTag(Object value)

  Set new tag/object under base key.

• setTag

   final Unit setTag(String key, Object value)

  Set new tag/object defined by key.

  Parameters:

  key - key that define object

  value - object itself or 'null' if we wants to remove it

• getTagsKeys

   final Array<String> getTagsKeys()

  Get all attached keys for tags.