Package 

Interface DataOtaDownloader

  • All Implemented Interfaces:
    
public interface DataOtaDownloader

    Public API for data ota downloader.

    Obtain instances from the corresponding service factory after SDK initialization. Threading, lifecycle, and error handling are described on individual methods.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • querySpaceDataStatus

         abstract RegionDataStatus querySpaceDataStatus(String space, Integer countryCode)

        Performs query space data status.

        Parameters:
        space - space
        countryCode - country code

      • startDownloadSpaceData

         abstract Integer startDownloadSpaceData(String space)

        Performs start download space data.

        Parameters:
        space - space

      • cancelDownloadSpaceData

         abstract Integer cancelDownloadSpaceData(String space)

        Performs cancel download space data.

        Parameters:
        space - space

      • applySpaceData

         abstract Integer applySpaceData(String space)

        Performs apply space data.

        Parameters:
        space - space

      • pauseDownloadSpaceData

         abstract Integer pauseDownloadSpaceData(String space)

        Pause downloading space data for a specific space. A small amount of data for the space will be continued to download after this interface is called as the pause operation is asynchronous.

        Parameters:
        space - the name of the space to pause downloading data for.

      • resumeDownloadSpaceData

         abstract Integer resumeDownloadSpaceData(String space)

        Performs resume download space data.

        Parameters:
        space - space

      • purgeSpaceDownloadData

        @WorkerThread() abstract Unit purgeSpaceDownloadData(String space)

        Purge the space data download for a specific space. This interface is synchronous, it may take some time to complete, recommend not to call it in the main thread. If the space is still in downloading/download paused/applying state, purge operation will do nothing. If purge successfully, space data status from @ref querySpaceDataStatus will be reset. If purge successfully, the temporary data of the space will be removed from the local storage. If download or(and) apply job of the space exists in listAllSpaceJobStatuses, after purge successfully, the jobs of this space will be removed from the result.

        Parameters:
        space - the name of the space to pause downloading data for.

      • removeInstalledSpaceData

        @WorkerThread() abstract Integer removeInstalledSpaceData(String space)

        Removes installed data for the given space.

        This call is synchronous and may take time. Avoid calling it on the main thread.

        Unlike purgeSpaceDownloadData, this method removes installed space data rather than temporary download data.

        Parameters:
        space - the space name.

      • isSpaceDownloadStorageSufficient

         abstract Boolean isSpaceDownloadStorageSufficient(List<String> spaces)

        Check whether current remaining storage space is sufficient for downloading spaces.

        Parameters:
        spaces - the space names to be downloaded.