com.amap.api.maps.offlinemap

## 类 OfflineMapManager

- java.lang.Object
- - com.amap.api.maps.offlinemap.OfflineMapManager

-     public final class OfflineMapManager
      extends java.lang.Object

  离线地图下载管理类，支持3D矢量地图下载。
  Offline map download management class, supports 3D vector map download.
  从以下版本开始:
    2.0.1

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static interface` | `OfflineMapManager.OfflineLoadedListener` 离线地图初始化完成回调 Offline map initialization completion callback
    `static interface` | `OfflineMapManager.OfflineMapDownloadListener` 离线地图下载过程中状态回调 Status callback during offline map download

  - ### 构造器概要

    构造器
    构造器和说明
    `OfflineMapManager(android.content.Context context, OfflineMapManager.OfflineMapDownloadListener listener)` 根据给定的参数来构造OfflineMapManager对象。
    `OfflineMapManager(android.content.Context context, OfflineMapManager.OfflineMapDownloadListener listener, AMap amap)` 根据给定的参数来构造OfflineMapManager对象。

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `destroy()` 销毁offlineManager中的资源 Destroy resources in offlineManager
    `void` | `downloadByCityCode(java.lang.String citycode)` 根据给定的城市编码下载该城市的离线地图包 异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法 Download the offline map package of the city based on the given city code.
    `void` | `downloadByCityName(java.lang.String cityname)` 根据给定的城市名称下载该城市的离线地图包 异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法 Download the offline map package of the city based on the given city name.
    `void` | `downloadByProvinceName(java.lang.String name)` 异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法。
    `java.util.ArrayList<OfflineMapCity>` | `getDownloadingCityList()` 所有正在下载或等待下载离线地图的城市列表。
    `java.util.ArrayList<OfflineMapProvince>` | `getDownloadingProvinceList()` 所有正在下载或等待下载离线地图的省份列表。
    `java.util.ArrayList<OfflineMapCity>` | `getDownloadOfflineMapCityList()` 返回已经下载完成离线地图的城市列表。
    `java.util.ArrayList<OfflineMapProvince>` | `getDownloadOfflineMapProvinceList()` 返回已经下载完成离线地图的省份列表。
    `OfflineMapCity` | `getItemByCityCode(java.lang.String cityCode)` 根据城市编码获取OfflineMapCity对象 同步方法 Get the OfflineMapCity object based on the city code.
    `OfflineMapCity` | `getItemByCityName(java.lang.String cityName)` 根据城市名称获取OfflneMapCity对象 同步方法 Get the OfflineMapCity object based on the city name.
    `OfflineMapProvince` | `getItemByProvinceName(java.lang.String provinceName)` 根据省份名称获取OfflineMapProvince对象 同步方法 Get the OfflineMapProvince object by province name Synchronous method
    `java.util.ArrayList<OfflineMapCity>` | `getOfflineMapCityList()` 获取所有存在有离线地图的城市列表。
    `java.util.ArrayList<OfflineMapProvince>` | `getOfflineMapProvinceList()` 获取所有存在有离线地图的省的列表。
    `void` | `pause()` 暂停离线地图下载。
    `void` | `pauseByName(java.lang.String name)`
    `void` | `remove(java.lang.String name)` 根据给定的城市名称删除该城市的离线地图包。
    `void` | `restart()` 重新开始任务,开始下载队列中的第一个为等待中的任务 Restart the task, start downloading the first waiting task in the queue
    `void` | `setOnOfflineLoadedListener(OfflineMapManager.OfflineLoadedListener listener)` 设置离线地图城市列表初始化回调。
    `void` | `stop()` 停止离线地图下载。
    `void` | `updateOfflineCityByCode(java.lang.String citycode)` 判断传入的城市（城市编码）是否有更新的离线数据包。
    `void` | `updateOfflineCityByName(java.lang.String cityname)` 判断传入的城市（城市名称）是否有更新的离线数据包。
    `void` | `updateOfflineMapProvinceByName(java.lang.String name)` 判断传入的省份名称是否有更新的离线数据包。

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### OfflineMapManager

          public OfflineMapManager(android.content.Context context,
                                   OfflineMapManager.OfflineMapDownloadListener listener)
                            throws java.lang.Exception

      根据给定的参数来构造OfflineMapManager对象。
      Construct an OfflineMapManager object based on the given parameters.
      参数:
        `context` - Context对象。
        Context object.
        `listener` - 下载事件监听。
        Download event listener.
      抛出:
        `java.lang.Exception`
      从以下版本开始:
        2.0.1

    - #### OfflineMapManager

          public OfflineMapManager(android.content.Context context,
                                   OfflineMapManager.OfflineMapDownloadListener listener,
                                   AMap amap)

      根据给定的参数来构造OfflineMapManager对象。
      Construct an OfflineMapManager object based on the given parameters.
      参数:
        `context` - Context对象。
        Context object.
        `listener` - 下载事件监听。
        Download event listener.
        `amap` - 当离线下载和地图在同一个页面，或者离线地图是后台下载时需要传入这个对象 可以保证缓存和离线数据不冲突，而且可以使得离线地图下载可直接使用。
        When offline download and the map are on the same page, or when the offline map is downloaded in the background, this object needs to be passed in to ensure that the cache and offline data do not conflict, and to allow the offline map download to be used directly.
      从以下版本开始:
        2.3.1

  - ### 方法详细资料

    - #### downloadByCityCode

          public void downloadByCityCode(java.lang.String citycode)
                                  throws AMapException

      根据给定的城市编码下载该城市的离线地图包
      异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法
      Download the offline map package of the city based on the given city code.
      Asynchronous method. If OfflineMapDownloadListener is registered, the download status will be called back via the onDownload method.
      参数:
        `citycode` - 城市编码
        City code
      抛出:
        `AMapException`
      从以下版本开始:
        2.5.1

    - #### downloadByCityName

          public void downloadByCityName(java.lang.String cityname)
                                  throws AMapException

      根据给定的城市名称下载该城市的离线地图包
      异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法
      Download the offline map package of the city based on the given city name.
      Asynchronous method. If OfflineMapDownloadListener is registered, the download status will be called back via the onDownload method.
      参数:
        `cityname` - 城市名称
        City name
      抛出:
        `AMapException`
      从以下版本开始:
        2.5.1

    - #### downloadByProvinceName

          public void downloadByProvinceName(java.lang.String name)
                                      throws AMapException

      异步方法，如果有注册OfflineMapDownloadListener监听，下载状态会回调onDownload方法。
      根据省份名称下载一个省份的离线地图包。
      省份离线地图包为改省下各个城市离线数据的合集
      Asynchronous method. If OfflineMapDownloadListener is registered, the download status will be called back via the onDownload method.
      Download an offline map package of a province based on the province name.
      The provincial offline map package is a collection of offline data from various cities under the province.
      参数:
        `name` - 省份名称
        Province name
      抛出:
        `AMapException`
      从以下版本开始:
        2.5.1

    - #### remove

          public void remove(java.lang.String name)

      根据给定的城市名称删除该城市的离线地图包。
      可以删除通过OfflineManager下载的数据;
      如果传入参数是省份，则会删除该省份以下的所有城市
      异步方法，删除操作会比较耗时，删除状态会在 `OfflineMapManager.OfflineMapDownloadListener.onRemove(boolean, String, String)` (boolean, String)} 中进行回调返回
      Delete the offline map package of the city based on the given city name.
      Can delete data downloaded via OfflineManager;
      If the parameter is a province, all cities under the province will be deleted.
      Asynchronous method. The deletion operation may take some time, and the deletion status will be called back via `OfflineMapManager.OfflineMapDownloadListener.onRemove(boolean, String, String)` (boolean, String)}.
      参数:
        `name` - 城市或省份的名称
        Name of the city or province
      从以下版本开始:
        2.1.0

    - #### getOfflineMapProvinceList

          public java.util.ArrayList<OfflineMapProvince> getOfflineMapProvinceList()

      获取所有存在有离线地图的省的列表。
      同步方法
      Get a list of all provinces that have offline maps.
      Synchronous method.
      返回:
        ArrayList
      从以下版本开始:
        2.1.0

    - #### getItemByCityCode

          public OfflineMapCity getItemByCityCode(java.lang.String cityCode)

      根据城市编码获取OfflineMapCity对象
      同步方法
      Get the OfflineMapCity object based on the city code.
      Synchronous method.
      参数:
        `cityCode` - 想查找城市编码
        Want to find the city code
      返回:
        返回对应的OfflineMapCity对象
        Return the corresponding OfflineMapCity object.
      从以下版本开始:
        2.1.0

    - #### getItemByCityName

          public OfflineMapCity getItemByCityName(java.lang.String cityName)

      根据城市名称获取OfflneMapCity对象
      同步方法
      Get the OfflineMapCity object based on the city name.
      Synchronous method.
      参数:
        `cityName` - 想查找城市名称
        Want to find the city name
      返回:
        返回对应的OfflneMapCity对象
        Return the corresponding OfflineMapCity object.
      从以下版本开始:
        2.1.0

    - #### getItemByProvinceName

          public OfflineMapProvince getItemByProvinceName(java.lang.String provinceName)

      根据省份名称获取OfflineMapProvince对象
      同步方法
      Get the OfflineMapProvince object by province name
      Synchronous method
      参数:
        `provinceName` - 省份名称
        Province name
      返回:
        返回对应的OfflineMapProvince对象
        Return the corresponding OfflineMapProvince object
      从以下版本开始:
        2.1.0

    - #### getOfflineMapCityList

          public java.util.ArrayList<OfflineMapCity> getOfflineMapCityList()

      获取所有存在有离线地图的城市列表。
      Get a list of all cities with offline maps.
      返回:
        ArrayList
      从以下版本开始:
        2.1.0

    - #### getDownloadingCityList

          public java.util.ArrayList<OfflineMapCity> getDownloadingCityList()

      所有正在下载或等待下载离线地图的城市列表。
      List of all cities downloading or waiting to download offline maps.
      返回:
        ArrayList
      从以下版本开始:
        2.1.0

    - #### getDownloadingProvinceList

          public java.util.ArrayList<OfflineMapProvince> getDownloadingProvinceList()

      所有正在下载或等待下载离线地图的省份列表。
      同步方法
      List of all provinces downloading or waiting to download offline maps.
      Synchronous method
      返回:
        ArrayList
      从以下版本开始:
        2.1.0

    - #### getDownloadOfflineMapCityList

          public java.util.ArrayList<OfflineMapCity> getDownloadOfflineMapCityList()

      返回已经下载完成离线地图的城市列表。
      Return the list of cities that have completed downloading offline maps.
      返回:
        List
      从以下版本开始:
        2.1.0

    - #### getDownloadOfflineMapProvinceList

          public java.util.ArrayList<OfflineMapProvince> getDownloadOfflineMapProvinceList()

      返回已经下载完成离线地图的省份列表。
      Return the list of provinces that have completed downloading offline maps.
      返回:
        ArrayList
      从以下版本开始:
        2.1.0

    - #### updateOfflineCityByCode

          public void updateOfflineCityByCode(java.lang.String citycode)
                                       throws AMapException

      判断传入的城市（城市编码）是否有更新的离线数据包。
      异步方法，会回调`OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)` 方法
      Determine whether the incoming city (city code) has an updated offline data package.
      Asynchronous method, will call back `OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)` method
      参数:
        `citycode` - 城市编码
        City code
      抛出:
        `AMapException` - 会根据cityCode去找城市，如果找不到就就会抛异常
        Will search for the city based on the cityCode, if not found, an exception will be thrown
      从以下版本开始:
        2.5.1

    - #### updateOfflineCityByName

          public void updateOfflineCityByName(java.lang.String cityname)
                                       throws AMapException

      判断传入的城市（城市名称）是否有更新的离线数据包。 异步方法，会回调 `OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)`方法
      Determine whether the incoming city (city name) has an updated offline data package. Asynchronous method, will call back `OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)` method
      参数:
        `cityname` - 城市名称
        City name
      抛出:
        `AMapException` - 如果名称错误，不存在该城市，会返回无效的参数异常
        If the name is wrong and the city does not exist, an invalid parameter exception will be returned
      从以下版本开始:
        2.5.1

    - #### updateOfflineMapProvinceByName

          public void updateOfflineMapProvinceByName(java.lang.String name)
                                              throws AMapException

      判断传入的省份名称是否有更新的离线数据包。
      异步方法，会回调`OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)` 方法
      Determine whether the incoming province name has an updated offline data package.
      Asynchronous method, will call back `OfflineMapManager.OfflineMapDownloadListener.onCheckUpdate(boolean, String)` method
      参数:
        `name` - 省份名称
        Province name
      抛出:
        `AMapException` - 如果名称错误，不存在该省份，会返回无效的参数异常
        If the name is wrong and the province does not exist, an invalid parameter exception will be returned
      从以下版本开始:
        2.5.1

    - #### restart

          public void restart()

      重新开始任务,开始下载队列中的第一个为等待中的任务
      Restart the task, start downloading the first waiting task in the queue
      从以下版本开始:
        2.0.1

    - #### stop

          public void stop()

      停止离线地图下载。
      暂停所有下载城市或省份，包括队列中的。
      Stop offline map download.
      Pause all downloading cities or provinces, including those in the queue.
      从以下版本开始:
        2.0.1

    - #### pause

          public void pause()

      暂停离线地图下载。
      暂停正在下载城市或省份，不包括队列中。
      每次开启下载任务，都会存放在队列中，且只能同时下载一个城市或省份的离线数据
      Pause offline map download.
      Pause the city or province currently downloading, excluding those in the queue.
      Every time a download task is started, it will be stored in the queue, and only one city or province's offline data can be downloaded at the same time
      从以下版本开始:
        2.0.1

    - #### pauseByName

          public void pauseByName(java.lang.String name)

    - #### destroy

          public void destroy()

      销毁offlineManager中的资源
      Destroy resources in offlineManager
      从以下版本开始:
        2.5.1

    - #### setOnOfflineLoadedListener

          public void setOnOfflineLoadedListener(OfflineMapManager.OfflineLoadedListener listener)

      设置离线地图城市列表初始化回调。
      Set the initialization callback for the offline map city list.
      参数:
        `listener` - 监听
      从以下版本开始:
        4.1.3