@magiclane/maps-sdk
↑↓ Navigate ⏎ Open Esc Close

Home > @magiclane/maps-sdk > SocialOverlay > addComment

SocialOverlay.addComment() method

Adds a text comment to an existing social report.

Submits user commentary on a social report, visible to all users viewing that report. Comments support community discussion and provide additional context. The comment appears in OverlayItem.previewData. Operation executes asynchronously with result delivered via onComplete callback.

Signature:

static addComment(input: {
        item: OverlayItem;
        comment: string;
        onComplete?: (error: GemError) => void;
    }): ProgressListener | null;

Parameters

Parameter

Type

Description

{ item, comment, onComplete, }

(not declared)

input

{ item: OverlayItem; comment: string; onComplete?: (error: GemError) => void; }

input properties:

  • item: OverlayItem
  • comment: string
  • Optional onComplete?: (error: GemError) => void

Returns:

ProgressListener | null

ProgressListener if operation was successfully initiated, null otherwise