立得地图iOS SDK 地图&搜索服务参考手册 V1.7.0
LMKOfflineMap.h
浏览该文件的文档.
1 //
2 // LMKOfflineMap.h
3 // LeadorMapSDK
4 //
5 // Copyright © 2016年 IShowChina. All rights reserved.
6 //
7 
10 #import "LMKOfflineProvince.h"
11 #import <Foundation/Foundation.h>
12 
13 
14 typedef NS_ENUM(NSInteger, LMKOfflineMapDownloadStatus) {
15  LMKOfflineMapDownloadStatusWaiting,
16  LMKOfflineMapDownloadStatusStart,
17  LMKOfflineMapDownloadStatusProgress,
18  LMKOfflineMapDownloadStatusCompleted,
19  LMKOfflineMapDownloadStatusCancelled,
20  LMKOfflineMapDownloadStatusUnzip,
21  LMKOfflineMapDownloadStatusFinished,
22  LMKOfflineMapDownloadStatusError
23 };
24 
25 /* 当downloadStatus == LMKOfflineMapDownloadStatusProgress 时, info参数是个NSDictionary,
26  如下两个key用来获取已下载和总和的数据大小(单位byte), 对应的是NSNumber(long long) 类型.
27  当downloadStatus == LMKOfflineMapDownloadStatusError 时, info参数是NSError. */
28 
29 extern NSString* const LMKOfflineMapDownloadReceivedSizeKey;
30 
31 extern NSString* const LMKOfflineMapDownloadExpectedSizeKey;
32 
33 typedef void (^LMKOfflineMapDownloadBlock)(LMKOfflineItem* downloadItem, LMKOfflineMapDownloadStatus downloadStatus, id info);
34 typedef void (^LMKOfflineMapPauseBlock)(LMKOfflineItem* downloadItem);
35 typedef void (^LMKOfflineMapDeleteBlock)(LMKOfflineItem* downloadItem);
36 typedef void (^LMKOfflineMapNewestVersionBlock)(BOOL hasNewestVersion);
37 typedef void (^LMKOfflineMapInitBlock)(BOOL isSuccess);
38 
42 @interface LMKOfflineMap : NSObject
43 
49 
55 - (void)initOfflineMap:(LMKOfflineMapInitBlock)initBlock;
59 @property (nonatomic, readonly) NSArray* provinces;
60 
64 @property (nonatomic, readonly) NSArray* municipalities;
65 
69 @property (nonatomic, readonly) NSArray* specialCities;
70 
74 @property (nonatomic, readonly) LMKOfflineItemNationWide* nationWide;
75 
79 @property (nonatomic, readonly) NSArray* cities;
80 
84 @property (nonatomic, copy) NSString* version;
85 
91 - (void)downloadItem:(LMKOfflineItem *)item downloadBlock:(LMKOfflineMapDownloadBlock)downloadBlock;
92 
98 - (BOOL)isDownloadingForItem:(LMKOfflineItem *)item;
99 
105 - (void)pauseItem:(LMKOfflineItem *)item pauseBlock:(LMKOfflineMapPauseBlock)pauseBlock;
106 
113 - (void)deleteItem:(LMKOfflineItem *)item type:(LMKOfflineDeleteType)deleteType deleteBlock:(LMKOfflineMapDeleteBlock)deleteBlock;
114 
118 - (void)cancelAll;
119 
123 - (void)clearCache;
124 
129 - (void)checkNewestVersion:(LMKOfflineMapNewestVersionBlock)newestVersionBlock;
130 
131 @end
132 
void clearCache()
清除所有在磁盘上的离线地图数据
NSString * version
离线数据的版本号(由年月日组成, 如"20130715")
Definition: LMKOfflineMap.h:84
LMKOfflineMap * sharedOfflineMap()
获取LMKOfflineMap 单例
void(^ LMKOfflineMapDownloadBlock)(LMKOfflineItem *downloadItem, LMKOfflineMapDownloadStatus downloadStatus, id info)
总大小
Definition: LMKOfflineMap.h:33
该类是离线地图模型的基类
Definition: LMKOfflineItem.h:28
NSArray * cities
城市数组, 包括普通城市与直辖市.
Definition: LMKOfflineMap.h:79
void(^ LMKOfflineMapInitBlock)(BOOL isSuccess)
自定义地图版本比较完成后的回调block
Definition: LMKOfflineMap.h:37
NSArray * municipalities
直辖市数组(每个元素均是LMKOfflineItemMunicipality类型)
Definition: LMKOfflineMap.h:64
LMKOfflineItemNationWide * nationWide
全国概要图
Definition: LMKOfflineMap.h:74
初始化离线地图的回调block
Definition: LMKOfflineMap.h:42
typedef NS_ENUM(NSInteger, LMKOfflineMapDownloadStatus)
Definition: LMKOfflineMap.h:14
NSArray * specialCities
港澳地区数组(每个元素均是LMKOfflineItem类型)
Definition: LMKOfflineMap.h:69
void(^ LMKOfflineMapDeleteBlock)(LMKOfflineItem *downloadItem)
暂停下载后的回调block
Definition: LMKOfflineMap.h:35
NSString *const LMKOfflineMapDownloadReceivedSizeKey
离线下载过程中的状态
全国概要图
Definition: LMKOfflineItemNationWide.h:13
NSString *const LMKOfflineMapDownloadExpectedSizeKey
已接受的数据大小
NSArray * provinces
省份数组(每个元素均是LMKOfflineProvince类型)
Definition: LMKOfflineMap.h:59
void(^ LMKOfflineMapNewestVersionBlock)(BOOL hasNewestVersion)
删除地图后的回调block
Definition: LMKOfflineMap.h:36
void(^ LMKOfflineMapPauseBlock)(LMKOfflineItem *downloadItem)
下载过程中的回调block
Definition: LMKOfflineMap.h:34
void cancelAll()
取消全部下载