AMapSearchObj.h 33 KB

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