Interface CatalogUpdateProgressListener


public interface CatalogUpdateProgressListener

Interface to get notified on status updates when updating catalog, previously downloaded by MapDownloader.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Called after the update process for all regions has been completed.
    void
    Called when update is paused.
    void
    onProgress(RegionId region, int percentage)
    Called multiple times to indicate the update progress.
    void
    Called when a paused map update is resumed.
  • Method Details

    • onProgress

      void onProgress(@NonNull RegionId region, int percentage)

      Called multiple times to indicate the update progress. Invoked on the main thread.

      Parameters:
      region -

      Represents an id of region status update is related to.

      percentage -

      Represents a percentage of catalog data which has been updated.

    • onPause

      void onPause(@Nullable MapLoaderError error)

      Called when update is paused. Invoked on the main thread.

      Parameters:
      error -

      Populated when a retryable error is the reason for a pause. A retryable error can happen, when, for example, the HERE SDK tries too often to resume a download that was paused due to a lost connection. In general, the HERE SDK will try a few times, before the update is paused. This error value gives a hint on the reason for the necessary retry operation. A paused download can be resumed by the user at a later time. It is 'null' when CatalogUpdateTask.pause(boolean) was called by the user.

    • onComplete

      void onComplete(@Nullable MapLoaderError error)

      Called after the update process for all regions has been completed. Invoked on the main thread.

      Parameters:
      error -

      Represents an error in case of a failure. If an error occurs, the operation cannot be resumed later. It is null for an operation that succeeds.

    • onResume

      void onResume()

      Called when a paused map update is resumed.