AMapSearchObj.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  1. //
  2. // AMapSearchObj.h
  3. // AMapSearchKit
  4. //
  5. // Created by xiaoming han on 15/7/22.
  6. // Copyright (c) 2015年 Amap. All rights reserved.
  7. //
  8. /* 该文件定义了搜索请求和返回对象。*/
  9. #import <Foundation/Foundation.h>
  10. #import "AMapCommonObj.h"
  11. ///沿途搜索类型
  12. typedef NS_ENUM(NSInteger, AMapRoutePOISearchType)
  13. {
  14. AMapRoutePOISearchTypeGasStation = 0, ///< 加油站
  15. AMapRoutePOISearchTypeMaintenanceStation = 1, ///< 维修站
  16. AMapRoutePOISearchTypeATM = 2, ///< ATM
  17. AMapRoutePOISearchTypeToilet = 3, ///< 厕所
  18. AMapRoutePOISearchTypeGasAirStation = 4, ///< 加气站
  19. AMapRoutePOISearchTypeParkStation = 5, ///< 服务区
  20. };
  21. ///天气查询类型
  22. typedef NS_ENUM(NSInteger, AMapWeatherType)
  23. {
  24. AMapWeatherTypeLive = 1, ///< 实时
  25. AMapWeatherTypeForecast ///< 预报
  26. };
  27. ///云图搜索结果排序
  28. typedef NS_ENUM(NSInteger, AMapCloudSortType)
  29. {
  30. AMapCloudSortTypeDESC = 0, ///< 降序
  31. AMapCloudSortTypeASC = 1 ///< 升序
  32. };
  33. ///附近搜索距离类型
  34. typedef NS_ENUM(NSInteger, AMapNearbySearchType)
  35. {
  36. AMapNearbySearchTypeLiner = 0, ///< 直线距离
  37. AMapNearbySearchTypeDriving = 1, ///< 驾车行驶距离
  38. };
  39. #pragma mark - AMapPOISearchBaseRequest
  40. ///POI搜索请求基类
  41. @interface AMapPOISearchBaseRequest : AMapSearchObject
  42. ///类型,多个类型用“|”分割 可选值:文本分类、分类代码
  43. @property (nonatomic, copy) NSString *types;
  44. ///排序规则, 0-距离排序;1-综合排序, 默认0
  45. @property (nonatomic, assign) NSInteger sortrule;
  46. ///每页记录数, 范围1-50, [default = 20]
  47. @property (nonatomic, assign) NSInteger offset;
  48. ///当前页数, 范围1-100, [default = 1]
  49. @property (nonatomic, assign) NSInteger page;
  50. ///建筑物POI编号,传入建筑物POI之后,则只在该建筑物之内进行搜索 since 4.5.0
  51. @property (nonatomic, copy) NSString *building;
  52. ///是否返回扩展信息,默认为 NO。
  53. @property (nonatomic, assign) BOOL requireExtension;
  54. ///是否返回子POI,默认为 NO。
  55. @property (nonatomic, assign) BOOL requireSubPOIs;
  56. @end
  57. ///POI ID搜索请求
  58. @interface AMapPOIIDSearchRequest : AMapPOISearchBaseRequest
  59. ///POI全局唯一ID
  60. @property (nonatomic, copy) NSString *uid;
  61. @end
  62. ///POI关键字搜索
  63. @interface AMapPOIKeywordsSearchRequest : AMapPOISearchBaseRequest
  64. ///查询关键字,多个关键字用“|”分割
  65. @property (nonatomic, copy) NSString *keywords;
  66. ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.(注:台湾地区一律设置为【台湾】,不具体到市。)
  67. @property (nonatomic, copy) NSString *city;
  68. ///强制城市限制功能 默认NO,例如:在上海搜索天安门,如果citylimit为true,将不返回北京的天安门相关的POI
  69. @property (nonatomic, assign) BOOL cityLimit;
  70. ///设置后,如果sortrule==0,则返回结果会按照距离此点的远近来排序,since 5.2.1
  71. @property (nonatomic, strong) AMapGeoPoint *location;
  72. @end
  73. ///POI周边搜索
  74. @interface AMapPOIAroundSearchRequest : AMapPOISearchBaseRequest
  75. ///查询关键字,多个关键字用“|”分割
  76. @property (nonatomic, copy) NSString *keywords;
  77. ///中心点坐标
  78. @property (nonatomic, copy) AMapGeoPoint *location;
  79. ///查询半径,范围:0-50000,单位:米 [default = 3000]
  80. @property (nonatomic, assign) NSInteger radius;
  81. @end
  82. ///POI多边形搜索
  83. @interface AMapPOIPolygonSearchRequest : AMapPOISearchBaseRequest
  84. ///查询关键字,多个关键字用“|”分割
  85. @property (nonatomic, copy) NSString *keywords;
  86. ///多边形
  87. @property (nonatomic, copy) AMapGeoPolygon *polygon;
  88. @end
  89. ///POI搜索返回
  90. @interface AMapPOISearchResponse : AMapSearchObject
  91. ///返回的POI数目
  92. @property (nonatomic, assign) NSInteger count;
  93. ///关键字建议列表和城市建议列表
  94. @property (nonatomic, strong) AMapSuggestion *suggestion;
  95. ///POI结果,AMapPOI 数组
  96. @property (nonatomic, strong) NSArray<AMapPOI *> *pois;
  97. @end
  98. #pragma mark - AMapPOIRouteSearchRequest
  99. ///沿途搜索, 注意起点和终点不能相距太远(大概70公里),否则可能搜索结果为空
  100. @interface AMapRoutePOISearchRequest : AMapSearchObject
  101. ///中心点坐标
  102. @property (nonatomic, copy) AMapGeoPoint *origin;
  103. ///目标点坐标
  104. @property (nonatomic, copy) AMapGeoPoint *destination;
  105. ///搜索类型
  106. @property (nonatomic, assign) AMapRoutePOISearchType searchType;
  107. ///驾车导航策略,同驾车路径规划请求的策略(5 多策略除外)
  108. @property (nonatomic, assign) NSInteger strategy;
  109. ///道路周围搜索范围,单位米,[0-500],默认250。
  110. @property (nonatomic, assign) NSInteger range;
  111. ///用户自己规划的路线,在origine、destination未填入时为必填.格式为:"经度,维度;经度,维度;...". 目前限制个数最多为100个点
  112. @property (nonatomic, strong) NSString *polylineStr;
  113. ///用户自己规划的路线,在origine、destination未填入且polylineStr未填入时为必填. 目前限制个数最多为100个点
  114. @property (nonatomic, strong) NSArray<AMapGeoPoint*> *polyline;
  115. @end
  116. ///沿途搜索返回
  117. @interface AMapRoutePOISearchResponse : AMapSearchObject
  118. ///返回的POI数目
  119. @property (nonatomic, assign) NSInteger count;
  120. ///POI结果,AMapRoutePOI 数组
  121. @property (nonatomic, strong) NSArray<AMapRoutePOI *> *pois;
  122. @end
  123. #pragma mark - AMapInputTipsSearchRequest
  124. ///搜索提示请求
  125. @interface AMapInputTipsSearchRequest : AMapSearchObject
  126. ///查询关键字
  127. @property (nonatomic, copy) NSString *keywords;
  128. ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.
  129. @property (nonatomic, copy) NSString *city;
  130. ///类型,多个类型用“|”分割 可选值:文本分类、分类代码
  131. @property (nonatomic, copy) NSString *types;
  132. ///强制城市限制功能,例如:在上海搜索天安门,如果citylimit为true,将不返回北京的天安门相关的POI
  133. @property (nonatomic, assign) BOOL cityLimit;
  134. ///格式形如:@"116.481488,39.990464",(经度,纬度),不可以包含空格。如果设置,在此location附近优先返回搜索关键词信息, since 5.0.0
  135. @property (nonatomic, copy) NSString *location;
  136. @end
  137. ///搜索提示返回
  138. @interface AMapInputTipsSearchResponse : AMapSearchObject
  139. ///返回数目
  140. @property (nonatomic, assign) NSInteger count;
  141. ///提示列表 AMapTip 数组, AMapTip 有多种属性,可根据该对象的返回信息,配合其他搜索服务使用,完善您应用的功能。如:\n 1)uid为空,location为空,该提示语为品牌词,可根据该品牌词进行POI关键词搜索。\n 2)uid不为空,location为空,为公交线路,根据uid进行公交线路查询。\n 3)uid不为空,location也不为空,是一个真实存在的POI,可直接显示在地图上。
  142. @property (nonatomic, strong) NSArray<AMapTip *> *tips;
  143. @end
  144. #pragma mark - AMapGeocodeSearchRequest
  145. ///地理编码请求
  146. @interface AMapGeocodeSearchRequest : AMapSearchObject
  147. ///地址
  148. @property (nonatomic, copy) NSString *address;
  149. ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.
  150. @property (nonatomic, copy) NSString *city;
  151. @end
  152. ///地理编码请求
  153. @interface AMapGeocodeSearchResponse : AMapSearchObject
  154. ///返回数目
  155. @property (nonatomic, assign) NSInteger count;
  156. ///地理编码结果 AMapGeocode 数组
  157. @property (nonatomic, strong) NSArray<AMapGeocode *> *geocodes;
  158. @end
  159. #pragma mark - AMapReGeocodeSearchRequest
  160. ///逆地理编码请求
  161. @interface AMapReGeocodeSearchRequest : AMapSearchObject
  162. ///是否返回扩展信息,默认NO。
  163. @property (nonatomic, assign) BOOL requireExtension;
  164. ///中心点坐标。
  165. @property (nonatomic, copy) AMapGeoPoint *location;
  166. ///查询半径,单位米,范围0~3000,默认1000。
  167. @property (nonatomic, assign) NSInteger radius;
  168. ///指定返回结果poi数组中的POI类型,在requireExtension=YES时生效。输入为typecode, 支持传入多个typecode, 多值时用“|”分割
  169. @property (nonatomic, copy) NSString *poitype;
  170. @end
  171. ///逆地理编码返回
  172. @interface AMapReGeocodeSearchResponse : AMapSearchObject
  173. ///逆地理编码结果
  174. @property (nonatomic, strong) AMapReGeocode *regeocode;
  175. @end
  176. #pragma mark - AMapBusStopSearchRequest
  177. ///公交站点请求
  178. @interface AMapBusStopSearchRequest : AMapSearchObject
  179. ///查询关键字
  180. @property (nonatomic, copy) NSString *keywords;
  181. ///城市 可选值:cityname(中文或中文全拼)、citycode、adcode
  182. @property (nonatomic, copy) NSString *city;
  183. ///每页记录数,默认为20,取值为:1-50
  184. @property (nonatomic, assign) NSInteger offset;
  185. ///当前页数,默认值为1,取值为:1-100
  186. @property (nonatomic, assign) NSInteger page;
  187. @end
  188. ///公交站点返回
  189. @interface AMapBusStopSearchResponse : AMapSearchObject
  190. ///公交站数目
  191. @property (nonatomic, assign) NSInteger count;
  192. ///关键字建议列表和城市建议列表
  193. @property (nonatomic, strong) AMapSuggestion *suggestion;
  194. ///公交站点数组,数组中存放AMapBusStop对象
  195. @property (nonatomic, strong) NSArray<AMapBusStop *> *busstops;
  196. @end
  197. #pragma mark - AMapBusLineSearchRequest
  198. ///公交线路查询请求基类,不可直接调用
  199. @interface AMapBusLineBaseSearchRequest : AMapSearchObject
  200. ///城市 可选值:cityname(中文或中文全拼)、citycode、adcode
  201. @property (nonatomic, copy) NSString *city;
  202. ///是否返回扩展信息,默认为NO
  203. @property (nonatomic, assign) BOOL requireExtension;
  204. ///每页记录数,默认为20,取值为1-50
  205. @property (nonatomic, assign) NSInteger offset;
  206. ///当前页数,默认为1,取值为1-100
  207. @property (nonatomic, assign) NSInteger page;
  208. @end
  209. ///公交站线路根据名字请求
  210. @interface AMapBusLineNameSearchRequest : AMapBusLineBaseSearchRequest
  211. ///查询关键字
  212. @property (nonatomic, copy) NSString *keywords;
  213. @end
  214. ///公交站线路根据ID请求
  215. @interface AMapBusLineIDSearchRequest : AMapBusLineBaseSearchRequest
  216. ///唯一标识
  217. @property (nonatomic, copy) NSString *uid;
  218. @end
  219. ///公交站线路返回
  220. @interface AMapBusLineSearchResponse : AMapSearchObject
  221. ///返回公交站数目
  222. @property (nonatomic, assign) NSInteger count;
  223. ///关键字建议列表和城市建议列表
  224. @property (nonatomic, strong) AMapSuggestion *suggestion;
  225. ///公交线路数组,数组中存放 AMapBusLine 对象
  226. @property (nonatomic, strong) NSArray<AMapBusLine *> *buslines;
  227. @end
  228. #pragma mark - AMapDistrictSearchRequest
  229. ///行政区划查询请求
  230. @interface AMapDistrictSearchRequest : AMapSearchObject
  231. ///查询关键字,只支持单关键字搜索,全国范围
  232. @property (nonatomic, copy) NSString *keywords;
  233. ///是否返回边界坐标,默认NO
  234. @property (nonatomic, assign) BOOL requireExtension;
  235. ///是否显示商圈信息,默认NO。注:已废弃,行政区划搜索无商圈信息。
  236. @property (nonatomic, assign) BOOL showBusinessArea __attribute__((deprecated("已废弃, from 5.3.0")));;
  237. @end
  238. ///行政区划响应
  239. @interface AMapDistrictSearchResponse : AMapSearchObject
  240. ///返回数目
  241. @property (nonatomic, assign) NSInteger count;
  242. ///行政区域 AMapDistrict 数组
  243. @property (nonatomic, strong) NSArray<AMapDistrict *> *districts;
  244. @end
  245. #pragma mark - AMapRouteSearchBaseRequest
  246. ///路径规划基础类,不可直接调用
  247. @interface AMapRouteSearchBaseRequest : AMapSearchObject
  248. ///出发点
  249. @property (nonatomic, copy) AMapGeoPoint *origin;
  250. ///目的地
  251. @property (nonatomic, copy) AMapGeoPoint *destination;
  252. @end
  253. #pragma mark - AMapDrivingRouteSearchRequest
  254. ///驾车路径规划
  255. @interface AMapDrivingRouteSearchRequest : AMapRouteSearchBaseRequest
  256. ///驾车导航策略([default = 0])\n 0速度优先(时间)\n 1费用优先(不走收费路段的最快道路)\n 2距离优先\n 3不走快速路\n 4躲避拥堵\n 5多策略(同时使用速度优先、费用优先、距离优先三个策略计算路径)。其中必须说明,就算使用三个策略算路,会根据路况不固定的返回一~三条路径规划信息\n 6不走高速\n 7不走高速且避免收费\n 8躲避收费和拥堵\n 9不走高速且躲避收费和拥堵\n 10多备选,时间最短,距离最短,躲避拥堵(考虑路况)\n 11多备选,时间最短,距离最短\n 12多备选,躲避拥堵(考虑路况)\n 13多备选,不走高速\n 14多备选,费用优先\n 15多备选,躲避拥堵,不走高速(考虑路况)\n 16多备选,费用有限,不走高速\n 17多备选,躲避拥堵,费用优先(考虑路况)\n 18多备选,躲避拥堵,不走高速,费用优先(考虑路况)\n 19多备选,高速优先\n 20多备选,高速优先,躲避拥堵(考虑路况)
  257. @property (nonatomic, assign) NSInteger strategy;
  258. ///途经点 AMapGeoPoint 数组,最多支持16个途经点
  259. @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
  260. ///避让区域 AMapGeoPolygon 数组,最多支持100个避让区域,每个区域16个点
  261. @property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
  262. ///避让道路名
  263. @property (nonatomic, copy) NSString *avoidroad;
  264. ///出发点 POI ID
  265. @property (nonatomic, copy) NSString *originId;
  266. ///目的地 POI ID
  267. @property (nonatomic, copy) NSString *destinationId;
  268. ///出发点POI类型编码
  269. @property (nonatomic, copy) NSString *origintype;
  270. ///目的地POI类型编码
  271. @property (nonatomic, copy) NSString *destinationtype;
  272. ///是否返回扩展信息,默认为 NO
  273. @property (nonatomic, assign) BOOL requireExtension;
  274. ///车牌省份,用汉字填入车牌省份缩写。用于判断是否限行
  275. @property (nonatomic, copy) NSString *plateProvince;
  276. ///车牌详情,填入除省份及标点之外的字母和数字(需大写)。用于判断是否限行。
  277. @property (nonatomic, copy) NSString *plateNumber;
  278. @end
  279. #pragma mark - AMapWalkingRouteSearchRequest
  280. ///步行路径规划
  281. @interface AMapWalkingRouteSearchRequest : AMapRouteSearchBaseRequest
  282. ///是否提供备选步行方案([default = 0])0-只提供一条步行方案; 1-提供备选步行方案(有可能无备选方案)
  283. @property (nonatomic, assign) NSInteger multipath __attribute__((deprecated("已废弃, from 5.0.0")));
  284. @end
  285. #pragma mark - AMapTransitRouteSearchRequest
  286. ///公交路径规划
  287. @interface AMapTransitRouteSearchRequest : AMapRouteSearchBaseRequest
  288. ///公交换乘策略([default = 0])\n 0-最快捷模式;\n 1-最经济模式;\n 2-最少换乘模式;\n 3-最少步行模式;\n 4-最舒适模式;\n 5-不乘地铁模式
  289. @property (nonatomic, assign) NSInteger strategy;
  290. ///城市, 必填
  291. @property (nonatomic, copy) NSString *city;
  292. ///目的城市, 跨城时需要填写,否则会出错
  293. @property (nonatomic, copy) NSString *destinationCity;
  294. ///是否包含夜班车,默认为 NO
  295. @property (nonatomic, assign) BOOL nightflag;
  296. ///是否返回扩展信息,默认为 NO
  297. @property (nonatomic, assign) BOOL requireExtension;
  298. @end
  299. #pragma mark - AMapRidingRouteSearchRequest
  300. ///骑行路径规划
  301. @interface AMapRidingRouteSearchRequest : AMapRouteSearchBaseRequest
  302. ///路径方案类型([default = 0])\n 0-推荐路线及最快路线综合\n 1-推荐路线\n 2-最快路线
  303. @property (nonatomic, assign) NSInteger type __attribute__((deprecated("已废弃, from 5.0.0")));
  304. @end
  305. ///路径规划返回
  306. @interface AMapRouteSearchResponse : AMapSearchObject
  307. ///路径规划信息数目
  308. @property (nonatomic, assign) NSInteger count;
  309. ///路径规划信息
  310. @property (nonatomic, strong) AMapRoute *route;
  311. @end
  312. ///骑行路径规划返回
  313. @interface AMapRidingRouteSearchResponse : AMapRouteSearchResponse
  314. @end
  315. #pragma mark - AMapWeatherSearchRequest
  316. ///天气查询请求
  317. @interface AMapWeatherSearchRequest : AMapSearchObject
  318. ///城市名称,支持cityname及adcode
  319. @property (nonatomic, copy) NSString *city;
  320. ///气象类型,Live为实时天气,Forecast为后三天预报天气,默认为Live
  321. @property (nonatomic, assign) AMapWeatherType type;
  322. @end
  323. ///天气查询返回
  324. @interface AMapWeatherSearchResponse : AMapSearchObject
  325. ///实时天气数据信息 AMapLocalWeatherLive 数组,仅在请求实时天气时有返回。
  326. @property (nonatomic, strong) NSArray<AMapLocalWeatherLive *> *lives;
  327. ///预报天气数据信息 AMapLocalWeatherForecast 数组,仅在请求预报天气时有返回
  328. @property (nonatomic, strong) NSArray<AMapLocalWeatherForecast *> *forecasts;
  329. @end
  330. #pragma mark - AMapRoadTrafficSearchRequest
  331. @interface AMapRoadTrafficSearchBaseRequest : AMapSearchObject
  332. ///道路等级,1:高速(京藏高速)2:城市快速路、国道(西三环、103国道) 3:高速辅路(G6辅路)4:主要道路(长安街、三环辅路路)5:一般道路(彩和坊路)6:无名道路。默认为5. since 5.5.0
  333. @property (nonatomic, assign) NSInteger level;
  334. ///是否返回扩展信息,默认为 NO
  335. @property (nonatomic, assign) BOOL requireExtension;
  336. @end
  337. ///道路实时路况查询请求 since 5.1.0
  338. @interface AMapRoadTrafficSearchRequest : AMapRoadTrafficSearchBaseRequest
  339. ///道路名称,可通过逆地理编码查询获取
  340. @property (nonatomic, copy) NSString *roadName;
  341. ///城市adcode,可参考http://a.amap.com/lbs/static/zip/AMap_adcode_citycode.zip
  342. @property (nonatomic, copy) NSString *adcode;
  343. @end
  344. ///圆形区域道路实时路况查询请求 since 5.5.0 注意:返回路况结果取决于发起请求时刻的实时路况,不保证范围内的所有路线路况都会返回,也不保证返回的路况长度一定在限制半径内
  345. @interface AMapRoadTrafficCircleSearchRequest : AMapRoadTrafficSearchBaseRequest
  346. ///必填,中心点坐标。
  347. @property (nonatomic, copy) AMapGeoPoint *location;
  348. ///查询半径,单位:米。[0, 5000], 默认值为1000.
  349. @property (nonatomic, assign) NSInteger radius;
  350. @end
  351. ///道路实时路况查询返回 since 5.1.0
  352. @interface AMapRoadTrafficSearchResponse : AMapSearchObject
  353. ///路况信息
  354. @property (nonatomic, strong) AMapTrafficInfo *trafficInfo;
  355. @end
  356. #pragma mark - AMapNearbySearchRequest
  357. ///附近搜索请求
  358. @interface AMapNearbySearchRequest : AMapSearchObject
  359. ///中心点坐标
  360. @property (nonatomic, copy) AMapGeoPoint *center;
  361. ///查询半径,范围:[0, 10000],单位:米 [default = 1000]
  362. @property (nonatomic, assign) NSInteger radius;
  363. ///搜索距离类型,默认为直线距离
  364. @property (nonatomic, assign) AMapNearbySearchType searchType;
  365. ///检索时间范围,超过24小时的数据无法返回,范围[5, 24*60*60] 单位:秒 [default = 1800]
  366. @property (nonatomic, assign) NSInteger timeRange;
  367. ///返回条数,范围[1, 100], 默认30
  368. @property (nonatomic, assign) NSInteger limit;
  369. @end
  370. ///附近搜索返回
  371. @interface AMapNearbySearchResponse : AMapSearchObject
  372. ///结果总条数
  373. @property (nonatomic, assign) NSInteger count;
  374. ///周边用户信息 AMapNearbyUserInfo 数组
  375. @property (nonatomic, strong) NSArray<AMapNearbyUserInfo *> *infos;
  376. @end
  377. #pragma mark - AMapCloudSearchBaseRequest
  378. ///云图搜索请求基类
  379. @interface AMapCloudSearchBaseRequest : AMapSearchObject
  380. ///要查询的表格ID, 必选
  381. @property (nonatomic, copy) NSString *tableID;
  382. ///筛选条件数组, 可选, 对建立了排序筛选索引的字段进行筛选(系统默认为:_id,_name,_address,_updatetime,_createtime建立排序筛选索引).\n 说明:\n 1.支持对文本字段的精确匹配;支持对整数和小数字段的连续区间筛选;\n 2.示例:数组{"type:酒店", "star:[3,5]"}的含义,等同于SQL语句:WHERE type = "酒店" AND star BETWEEN 3 AND 5\n 注意: 所设置的过滤条件中不能含有&、#、%等URL的特殊符号。
  383. @property (nonatomic, strong) NSArray<NSString *> *filter;
  384. ///排序字段名, 可选.\n 说明:\n 1.支持按建立了排序筛选索引的整数或小数字段进行排序:sortFields = "字段名";\n 2.系统预设的字段(忽略sortType):_distance:坐标与中心点距离升序排序,仅在周边检索时有效;_weight:权重降序排序,当存在keywords时有效;\n 3.默认值:当keywords存在时:默认按预设字段_weight排序;当keywords不存在时,默认按预设字段_distance排序;按建立了排序筛选索引的整数或小数字段进行排序时,若不填升降序,则默认按升序排列;
  385. @property (nonatomic, copy) NSString *sortFields;
  386. ///可选, 排序方式(默认升序)
  387. @property (nonatomic, assign) AMapCloudSortType sortType;
  388. ///可选, 每页记录数(每页最大记录数100, 默认20)
  389. @property (nonatomic, assign) NSInteger offset;
  390. ///可选, 当前页数(>=1, 默认1)
  391. @property (nonatomic, assign) NSInteger page;
  392. @end
  393. #pragma mark - AMapCloudPlaceAroundSearchRequest
  394. ///云图周边搜请求
  395. @interface AMapCloudPOIAroundSearchRequest : AMapCloudSearchBaseRequest
  396. ///必填,中心点坐标。
  397. @property (nonatomic, copy) AMapGeoPoint *center;
  398. ///可选,查询半径(默认值为3000),单位:米。详细信息请参考:http://lbs.amap.com/yuntu/reference/cloudsearch/#t2
  399. @property (nonatomic, assign) NSInteger radius;
  400. ///可选,搜索关键词。\n 说明:\n 1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为 _name 和 _address 建立文本索引;\n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如 keywords = “工商银行”,检索返回已建立文本索引列值中包含"工商"或者"银行"或者"工商银行"关键字的POI结果集。 \n 3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如 keywords = "招商银行|华夏银行|工商银行",检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。 \n 4. 可赋值为空值,即 keywords = " " 表示空值; \n 5. 若 city = "城市名",keywords = " " 或者 keywords = "关键字",返回对应城市的全部数据或对应关键字的数据; \n 6. 一次请求最多返回2000条数据。\n 注意: 所设置的keywords中不能含有&、#、%等URL的特殊符号。
  401. @property (nonatomic, copy) NSString *keywords;
  402. @end
  403. ///云图polygon区域查询请求
  404. @interface AMapCloudPOIPolygonSearchRequest : AMapCloudSearchBaseRequest
  405. ///必填,多边形。
  406. @property (nonatomic, copy) AMapGeoPolygon *polygon;
  407. ///可选,搜索关键词。\n 说明:\n 1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为 _name 和 _address 建立文本索引;\n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如 keywords = “工商银行”,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。\n 3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如 keywords = "招商银行|华夏银行|工商银行",检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。\n 4. 可赋值为空值,即 keywords = " " 表示空值;\n 5. 若 city = "城市名",keywords = " " 或者 keywords = "关键字",返回对应城市的全部数据或对应关键字的数据;\n 6. 一次请求最多返回2000条数据。\n 注意: 所设置的keywords中不能含有&、#、%等URL的特殊符号。
  408. @property (nonatomic, copy) NSString *keywords;
  409. @end
  410. ///云图ID查询请求
  411. @interface AMapCloudPOIIDSearchRequest : AMapCloudSearchBaseRequest
  412. ///必填,POI的ID
  413. @property (nonatomic, assign) NSInteger uid;
  414. @end
  415. ///云图本地查询请求
  416. @interface AMapCloudPOILocalSearchRequest : AMapCloudSearchBaseRequest
  417. ///必填,搜索关键词。\n 说明:\n 1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为 _name 和 _address 建立文本索引;\n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如 keywords = "工商银行",检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。\n 3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如 keywords = "招商银行|华夏银行|工商银行",检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。\n 4. 可赋值为空值,即 keywords = " " 表示空值;\n 5. 若 city = "城市名",keywords = " " 或者 keywords = "关键字",返回对应城市的全部数据或对应关键字的数据;\n 6. 一次请求最多返回2000条数据。 注意: 所设置的keywords中不能含有&、#、%等URL的特殊符号。
  418. @property (nonatomic, copy) NSString *keywords;
  419. ///必填,城市名称\n 说明:\n 1. 支持全国/省/市/区县行政区划范围的检索;\n 2. city = "全国",即对用户全表搜索;\n 3. 当city值设置非法或不正确时,按照 city = "全国"返回。
  420. @property (nonatomic, copy) NSString *city;
  421. @end
  422. ///云图搜索返回
  423. @interface AMapCloudPOISearchResponse : AMapSearchObject
  424. ///返回结果总数目
  425. @property (nonatomic, assign) NSInteger count;
  426. ///返回的结果, AMapCloudPOI 数组
  427. @property (nonatomic, strong) NSArray<AMapCloudPOI *> *POIs;
  428. @end
  429. #pragma mark - AMapShareSearchBaseRequest
  430. ///短串分享搜索请求基类, 请使用具体的子类。
  431. @interface AMapShareSearchBaseRequest : AMapSearchObject
  432. @end
  433. ///位置短串分享请求
  434. @interface AMapLocationShareSearchRequest : AMapShareSearchBaseRequest
  435. ///必填, 位置坐标
  436. @property (nonatomic, copy) AMapGeoPoint *location;
  437. ///位置名称,请不要包含【,%&@#】等特殊符号
  438. @property (nonatomic, copy) NSString *name;
  439. @end
  440. ///兴趣点短串分享请求
  441. @interface AMapPOIShareSearchRequest : AMapShareSearchBaseRequest
  442. ///POI的ID,如果有ID则指定POI,否则按name查询。
  443. @property (nonatomic, copy) NSString *uid;
  444. ///坐标
  445. @property (nonatomic, copy) AMapGeoPoint *location;
  446. ///名称,请不要包含【,%&@#】等特殊符号。
  447. @property (nonatomic, copy) NSString *name;
  448. ///地址,请不要包含【,%&@#】等特殊符号。
  449. @property (nonatomic, copy) NSString *address;
  450. @end
  451. ///路径规划短串分享请求
  452. @interface AMapRouteShareSearchRequest : AMapShareSearchBaseRequest
  453. ///默认为0\n 驾车:0-速度最快(时间);\n 1-避免收费(不走收费路段的最快道路);\n 2-距离优先;\n 3-不走高速;\n 4-结合实时交通(躲避拥堵);\n 5-不走高速且避免收费;\n 6-不走高速且躲避拥堵;\n 7-躲避收费和拥堵;\n 8-不走高速且躲避收费和拥堵\n\n 公交:0-最快捷;\n 1-最经济;\n 2-最少换乘;\n 3-最少步行;\n 4-最舒适;\n 5-不乘地铁;\n\n 步行,无策略,均一样
  454. @property (nonatomic, assign) NSInteger strategy;
  455. ///Route的type,默认为0,超出范围为0.\n 0为驾车,\n 1为公交,\n 2为步行
  456. @property (nonatomic, assign) NSInteger type;
  457. ///起点坐标
  458. @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
  459. ///终点坐标
  460. @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
  461. ///起点名称,默认为“已选择的位置”,请不要包含【,%&@#】等特殊符号
  462. @property (nonatomic, copy) NSString *startName;
  463. ///终点名称,默认为“已选择的位置”,请不要包含【,%&@#】等特殊符号
  464. @property (nonatomic, copy) NSString *destinationName;
  465. @end
  466. ///导航短串分享请求
  467. @interface AMapNavigationShareSearchRequest : AMapShareSearchBaseRequest
  468. ///默认为0,超出范围为0\n 驾车:0-速度最快(时间);\n 1-避免收费(不走收费路段的最快道路);\n 2-距离优先;\n 3-不走高速;\n 4-结合实时交通(躲避拥堵);\n 5-不走高速且避免收费;\n 6-不走高速且躲避拥堵;\n 7-躲避收费和拥堵;\n 8-不走高速且躲避收费和拥堵
  469. @property (nonatomic, assign) NSInteger strategy;
  470. ///起点坐标,若跳转到高德地图,默认更换为定位坐标
  471. @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
  472. ///终点坐标
  473. @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
  474. @end
  475. ///导航短串分享响应
  476. @interface AMapShareSearchResponse : AMapSearchObject
  477. ///转换后的短串
  478. @property (nonatomic, copy) NSString *shareURL;
  479. @end