Maps SDK for Android/com.magiclane.sdk.core/SocialOverlay

SocialOverlay

object SocialOverlay : GemNativeObj

SocialOverlay object. This behaves like a singleton, i.e. all instances are sharing behind the same API interface

Properties

labelsOverlayInfo

val labelsOverlayInfo: SocialLabelsOverlayInfo?

Labels overlay info

var onCompleted: OnCompleted?

On completed trigger.

var onStarted: OnStarted?

On started trigger.

reportsOverlayInfo

val reportsOverlayInfo: SocialReportsOverlayInfo?

Social reports overlay info

transferStatistics

val transferStatistics: TransferStatistics?

Data transfer statistics for this service.

Inherited properties

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Functions

external fun addComment(item: OverlayItem, comment: String, listener: ProgressListener): Int

Add a comment to report

external fun addLabel(result: OverlayItem, coordinates: Coordinates, image: String, name: String, details: DataBuffer, validitySec: Int, listener: ProgressListener, labelCategoryId: Int = -1): Int

Add a social label

external fun cancel(listener: ProgressListener)

Cancel the current active search / refresh

external fun confirmReport(item: OverlayItem, listener: ProgressListener): Int

Confirm an existing report as in effect

external fun deleteReport(item: OverlayItem, listener: ProgressListener): Int

Delete an owned report

external fun denyReport(item: OverlayItem, listener: ProgressListener): Int

Denied an existing report as not in effect anymore

getReportSnapshot

external fun getReportSnapshot(item: OverlayItem, image: Image, listener: ProgressListener): Int

Get report snapshot

prepareReporting

external fun prepareReporting(categoryId: Int = 0, dataSource: DataSource = PositionService.dataSource!!): Int

Prepare reporting

prepareReportingWithCoordinates

external fun prepareReportingWithCoordinates(coordinates: Coordinates, categoryId: Int = 0): Int

Prepare reporting

registerOverlayItemListener

external fun registerOverlayItemListener(item: OverlayItem, listener: SocialOverlayItemListener)

Register the given "listener" for the given "item"

external fun report(prepareId: Int, categoryId: Int, listener: ProgressListener, description: String? = null, params: ParameterList? = null, snapshot: Image? = null): Int

Report an social event

setLabelsListener

external fun setLabelsListener(labelCategoryId: Int, listener: SocialLabelListener): Int

Sets the label overlay listener

unregisterOverlayItemListener

external fun unregisterOverlayItemListener(item: OverlayItem, listener: SocialOverlayItemListener)

Unregister the given "listener" for the given "item"

external fun updateReport(item: OverlayItem, params: ParameterList, listener: ProgressListener): Int

Update an existing report description & parameters

Inherited functions

Overrides finalize that garbage collector will call when needed.

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

operator fun not(): Boolean

Checks if this object is valid.

Releases the native referenced value of this object if: