SocialOverlay class abstract Routes & Navigation

SocialOverlay allows reporting and retrieval of social events.

A service for reporting and consuming crowd‑sourced social events on the map, designed for asynchronous use. It supports creating reports (including optional data), preparing reports from explicit coordinates or the current device position, and reacting to reports with confirmations, denials, updates, deletions and comment threads.

See the AlarmService class for operations regarding alarm events, including incoming crowd‑sourced social events.

Constructors

SocialOverlay.new()

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

reportsOverlayInfo → SocialReportsOverlayInfo: Gets social reports overlay info.
no setter
transferStatistics → TransferStatistics: Gets the transfer statistics.
no setter

Static Methods

addComment({required OverlayItem item, required String comment, void onComplete(GemError error)?}) → EventHandler?: Adds a comment to a report.
cancel(EventHandler handler) → void: Cancels a Social Overlay operation.
confirmReport(OverlayItem item, {void onComplete(GemError error)?}) → EventHandler?: Confirms an existing report as in effect.
deleteReport(OverlayItem item, {void onComplete(GemError error)?}) → EventHandler?: Deletes an owned report.
denyReport(OverlayItem item, {void onComplete(GemError error)?}) → EventHandler?: Denies an existing report as not in effect anymore.
prepareReporting({int categId = 0}) → int: Prepares reporting based on the current data source used by PositionService.
prepareReportingCoords(Coordinates coords, {int categId = 0}) → int: Prepares reporting based on custom coordinates.
registerReportListener(OverlayItem report, SocialReportListener listener) → GemError: Registers the given listener for the given report item.
report({required int prepareId, required int categId, String description = '', Uint8List? snapshot, ImageFileFormat? format, ParameterList? params, void onComplete(GemError error)?}) → EventHandler?: Reports a social event.
unregisterReportListener(OverlayItem report, SocialReportListener listener) → GemError: Unregisters the given listener for the given report item.
updateReport({required OverlayItem item, required SearchableParameterList params, void onComplete(GemError error)?}) → EventHandler?: Updates an existing report's parameters.