SocialOverlay

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

Properties

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

On completed trigger.

Link copied to clipboard

On started trigger.

Link copied to clipboard

Social reports overlay info

Link copied to clipboard

Data transfer statistics for this service.

Functions

Link copied to clipboard
external fun addComment(item: OverlayItem, comment: String, listener: ProgressListener): Int

Add a comment to report

Link copied to clipboard
external fun addLabel(coordinates: Coordinates, image: String, name: String, details: DataBuffer, validitySec: Int, listener: ProgressListener, labelCategoryId: Int = -1): Int

Add a social label

Link copied to clipboard
external fun cancel(listener: ProgressListener)

Cancel the current active search / refresh

Link copied to clipboard
external fun confirmReport(item: OverlayItem, listener: ProgressListener): Int

Confirm an existing report as in effect

Link copied to clipboard
external fun deleteReport(item: OverlayItem, listener: ProgressListener): Int

Delete an owned report

Link copied to clipboard
external fun denyReport(item: OverlayItem, listener: ProgressListener): Int

Denied an existing report as not in effect anymore

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getReportSnapshot(item: OverlayItem, image: Image, listener: ProgressListener): Int

Get report snapshot

Link copied to clipboard

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

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

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

Prepare reporting

Link copied to clipboard
external fun prepareReportingWithCoordinates(coordinates: Coordinates, categoryId: Int = 0): Int

Prepare reporting

Link copied to clipboard
fun refreshReports(landmarks: LandmarkList, itemsList: ArrayList<OverlayItem>): Int

Refresh reports and POIs results list

Link copied to clipboard

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

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

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

Report an social event

Link copied to clipboard
external fun searchAroundPOIAndReports(lmkResult: GemList<LandmarkPosition>, result: GemList<OverlayItemPosition>, filterCategoryId: Int, position: Coordinates, maxResults: Int, listener: ProgressListener): Int

Async search for POIs and reports

Link copied to clipboard
external fun searchLabelsAlongRoute(result: GemList<OverlayItemPosition>, route: Route, maxResults: Int, listener: ProgressListener, labelCategoryId: Int = -1, filterCategoriesIds: ArrayList<Int> = ArrayList()): Int

Search for labels along the given route

Link copied to clipboard
external fun searchLabelsAround(result: GemList<OverlayItemPosition>, position: Coordinates, maxResults: Int, listener: ProgressListener, labelCategoryId: Int = -1, filterCategoriesIds: ArrayList<Int> = ArrayList()): Int

Search for labels around given coordinates

Link copied to clipboard
external fun searchReportsAlongRoute(result: GemList<OverlayItemPosition>, route: Route, maxResults: Int, listener: ProgressListener, filterCategoriesIds: ArrayList<Int> = ArrayList()): Int

Async search reports along the given route

Link copied to clipboard
external fun searchReportsAround(result: GemList<OverlayItemPosition>, position: Coordinates, maxResults: Int, listener: ProgressListener, filterCategoriesIds: ArrayList<Int>): Int

Async search reports around given coordinates

Link copied to clipboard
external fun searchReportsForPOIs(landmarks: GemList<Landmark>, result: GemList<OverlayItem>, listener: ProgressListener): Int

Async search POI reports attached to the given landmark list

Link copied to clipboard
external fun setLabelsListener(labelCategoryId: Int, listener: SocialLabelListener): Int

Sets the label overlay listener

Link copied to clipboard

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

Link copied to clipboard
external fun updateReport(item: OverlayItem, params: ParameterList, listener: ProgressListener): Int

Update an existing report description & parameters