requestWikiImageInfo method

ProgressListener? requestWikiImageInfo({ required int imageIndex, required void onComplete(GemError error, String? imageInfo), })

Asynchronously requests information about a Wikipedia image.

The information (for example metadata or an information string) is delivered via onComplete. A ProgressListener is returned when the operation starts and can be used to monitor or cancel the request.

Parameters

• imageIndex: Zero-based index of the requested image.
• onComplete: Callback invoked when the request completes. Depending on the result, the callback receives a GemError and the optional image:
  • GemError.success for err and the image info string for imageInfo on success.
  • GemError.general describing the failure reason and null for imageInfo on error.

Returns

• ProgressListener?: A progress listener when the operation started, otherwise null.

Example:

externalInfo.requestWikiImageInfo(
 imageIndex: 0,
 onComplete: (err, info) {
    if (err == GemError.success) {
      print('Successfully retrieved Wiki image info.');
      // Use the retrieved info as needed
    } else if (info != null) {
      print('Failed to retrieve Wiki image info.');
    }
  },
);

Also see:

• imageIndex — Get the total number of images.
• requestWikiImage — Request Wikipedia image.
• cancelWikiImageInfoRequest — Cancel a pending image info request.

Implementation

ProgressListener? requestWikiImageInfo({
  required int imageIndex,
  required void Function(GemError error, String? imageInfo) onComplete,
}) {
  final StringHolder result = StringHolder();
  final EventDrivenProgressListener listener = EventDrivenProgressListener();
  GemKitPlatform.instance.registerEventHandler(listener.id, listener);

  listener.registerOnCompleteWithData((
    final int err,
    final String hint,
    final Map<dynamic, dynamic> json,
  ) {
    GemKitPlatform.instance.unregisterEventHandler(listener.id);
    if (err == 0) {
      onComplete(GemErrorExtension.fromCode(err), result.value);
    } else {
      onComplete(GemErrorExtension.fromCode(err), null);
    }
    result.dispose();
  });

  objectMethod(
    pointerId,
    'ExternalInfo',
    'requestWikiImageInfo',
    args: <String, dynamic>{
      'progressListener': listener.id,
      'nImageIdx': imageIndex,
      'strImageInfo': result.pointerId,
    },
  );

  final GemError err = ApiErrorService.apiError;
  if (err != GemError.success) {
    GemKitPlatform.instance.unregisterEventHandler(listener.id);
    onComplete(err, null);
    return null;
  }

  return listener;
}