Home > @magiclane/maps-sdk > SocialOverlay > report
SocialOverlay.report() method
Submits a prepared social event report to the community.
Uploads a previously prepared report (via prepareReporting or prepareReportingCoords) with the specified category, optional description, image snapshot, and custom parameters. The report becomes visible to all users with social overlay enabled and displays for a limited duration before automatic removal.
Signature:
static report(input: {
prepareId: number;
categId: number;
description?: string;
snapshot?: Uint8Array | null;
format?: ImageFileFormat | null;
params?: ParameterList | null;
onComplete?: (error: GemError) => void;
}): ProgressListener | null;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
{ prepareId, categId, description, snapshot, format, params, onComplete, } |
(not declared) | |
|
input |
{ prepareId: number; categId: number; description?: string; snapshot?: Uint8Array | null; format?: ImageFileFormat | null; params?: ParameterList | null; onComplete?: (error: GemError) => void; } |
input properties:
- prepareId: number
- categId: number
- Optional description?: string
- Optional snapshot?: Uint8Array | null
- Optional format?: ImageFileFormat | null
- Optional params?: ParameterList | null
- Optional onComplete?: (error: GemError) => void
Returns:
ProgressListener | null
ProgressListener if operation was successfully initiated, null otherwise