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

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

SocialOverlay.getReportSnapshot() method

Retrieves the image snapshot associated with a social report.

Downloads the photo attached to a social report when submitted with image data. Only applicable to Social Reports Overlay items. Returns image via onComplete callback with Img result. Operation executes asynchronously with progress tracking.

Signature:

static getReportSnapshot(input: {
        item: OverlayItem;
        onComplete: (error: GemError, imageInfo: Img | null) => void;
    }): ProgressListener | null;

Parameters

Parameter

Type

Description

{ item, onComplete, }

(not declared)

input

{ item: OverlayItem; onComplete: (error: GemError, imageInfo: Img | null) => void; }

input properties:

  • item: OverlayItem
  • onComplete: (error: GemError, imageInfo: Img | null) => void

Returns:

ProgressListener | null

ProgressListener for tracking operation progress if started successfully, null otherwise