AMapSearchAPI.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. //
  2. // AMapSearchAPI.h
  3. // AMapSearchKit
  4. //
  5. // Created by xiaoming han on 15/7/22.
  6. // Copyright (c) 2015年 Amap. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "AMapSearchObj.h"
  10. #import "AMapCommonObj.h"
  11. @protocol AMapSearchDelegate;
  12. ///搜索结果语言
  13. typedef NS_ENUM(NSInteger, AMapSearchLanguage)
  14. {
  15. AMapSearchLanguageZhCN = 0, ///< 中文
  16. AMapSearchLanguageEn = 1 ///< 英文
  17. };
  18. ///搜索类
  19. @interface AMapSearchAPI : NSObject
  20. ///实现了 AMapSearchDelegate 协议的类指针。
  21. @property (nonatomic, weak) id<AMapSearchDelegate> delegate;
  22. ///查询超时时间,单位秒,默认为20秒。
  23. @property (nonatomic, assign) NSInteger timeout;
  24. ///查询结果返回语言, 默认为中文。
  25. @property (nonatomic, assign) AMapSearchLanguage language;
  26. /**
  27. * @brief AMapSearch的初始化函数。
  28. * 初始化之前请正确设置key,否则将无法正常使用搜索服务.
  29. * @return AMapSearch类对象实例
  30. */
  31. - (instancetype)init;
  32. /**
  33. * @brief 取消所有未回调的请求,触发错误回调。
  34. */
  35. - (void)cancelAllRequests;
  36. #pragma mark - 搜索服务接口
  37. /**
  38. * @brief POI ID查询接口
  39. * @param request 查询选项。具体属性字段请参考 AMapPOIIDSearchRequest 类。
  40. */
  41. - (void)AMapPOIIDSearch:(AMapPOIIDSearchRequest *)request;
  42. /**
  43. * @brief POI 关键字查询接口
  44. * @param request 查询选项。具体属性字段请参考 AMapPOIKeywordsSearchRequest 类。
  45. */
  46. - (void)AMapPOIKeywordsSearch:(AMapPOIKeywordsSearchRequest *)request;
  47. /**
  48. * @brief POI 周边查询接口
  49. * @param request 查询选项。具体属性字段请参考 AMapPOIAroundSearchRequest 类。
  50. */
  51. - (void)AMapPOIAroundSearch:(AMapPOIAroundSearchRequest *)request;
  52. /**
  53. * @brief POI 多边形查询接口
  54. * @param request 查询选项。具体属性字段请参考 AMapPOIPolygonSearchRequest 类。
  55. */
  56. - (void)AMapPOIPolygonSearch:(AMapPOIPolygonSearchRequest *)request;
  57. /**
  58. * @brief 沿途查询接口 (v4.3.0)
  59. * @param request 查询选项。具体属性字段请参考 AMapRoutePOISearchRequest 类。
  60. */
  61. - (void)AMapRoutePOISearch:(AMapRoutePOISearchRequest *)request;
  62. /**
  63. * @brief 地址编码查询接口
  64. * @param request 查询选项。具体属性字段请参考 AMapGeocodeSearchRequest 类。
  65. */
  66. - (void)AMapGeocodeSearch:(AMapGeocodeSearchRequest *)request;
  67. /**
  68. * @brief 逆地址编码查询接口
  69. * @param request 查询选项。具体属性字段请参考 AMapReGeocodeSearchRequest 类。
  70. */
  71. - (void)AMapReGoecodeSearch:(AMapReGeocodeSearchRequest *)request;
  72. /**
  73. * @brief 输入提示查询接口
  74. * @param request 查询选项。具体属性字段请参考 AMapInputTipsSearchRequest 类。
  75. */
  76. - (void)AMapInputTipsSearch:(AMapInputTipsSearchRequest *)request;
  77. /**
  78. * @brief 公交站点查询接口
  79. * @param request 查询选项。具体属性字段请参考 AMapBusStopSearchRequest 类。
  80. */
  81. - (void)AMapBusStopSearch:(AMapBusStopSearchRequest *)request;
  82. /**
  83. * @brief 公交线路关键字查询
  84. * @param request 查询选项。具体属性字段请参考 AMapBusLineIDSearchRequest 类。
  85. */
  86. - (void)AMapBusLineIDSearch:(AMapBusLineIDSearchRequest *)request;
  87. /**
  88. * @brief 公交线路关键字查询
  89. * @param request 查询选项。具体属性字段请参考 AMapBusLineNameSearchRequest 类。
  90. */
  91. - (void)AMapBusLineNameSearch:(AMapBusLineNameSearchRequest *)request;
  92. /**
  93. * @brief 行政区域查询接口
  94. * @param request 查询选项。具体属性字段请参考 AMapDistrictSearchRequest 类。
  95. */
  96. - (void)AMapDistrictSearch:(AMapDistrictSearchRequest *)request;
  97. /**
  98. * @brief 驾车路径规划查询接口
  99. * @param request 查询选项。具体属性字段请参考 AMapDrivingRouteSearchRequest 类。
  100. */
  101. - (void)AMapDrivingRouteSearch:(AMapDrivingRouteSearchRequest *)request;
  102. /**
  103. * @brief 步行路径规划查询接口
  104. * @param request 查询选项。具体属性字段请参考 AMapWalkingRouteSearchRequest 类。
  105. */
  106. - (void)AMapWalkingRouteSearch:(AMapWalkingRouteSearchRequest *)request;
  107. /**
  108. * @brief 公交路径规划查询接口
  109. * @param request 查询选项。具体属性字段请参考 AMapTransitRouteSearchRequest 类。
  110. */
  111. - (void)AMapTransitRouteSearch:(AMapTransitRouteSearchRequest *)request;
  112. /**
  113. * @brief 骑行路径规划查询接口 (v4.3.0)
  114. * @param request 查询选项。具体属性字段请参考 AMapRidingRouteSearchRequest 类。
  115. */
  116. - (void)AMapRidingRouteSearch:(AMapRidingRouteSearchRequest *)request;
  117. /**
  118. * @brief 天气查询接口
  119. * @param request 查询选项。具体属性字段请参考 AMapWeatherSearchRequest 类。
  120. */
  121. - (void)AMapWeatherSearch:(AMapWeatherSearchRequest *)request;
  122. /**
  123. * @brief 查询指定道路的实时路况 since 5.1.0
  124. * @param request 查询选项。具体属性字段请参考 AMapRoadTrafficSearchRequest 类。
  125. */
  126. - (void)AMapRoadTrafficSearch:(AMapRoadTrafficSearchRequest *)request;
  127. /**
  128. * @brief 查询圆形区域内道路的实时路况 since 5.5.0
  129. * @param request 查询选项。具体属性字段请参考 AMapRoadTrafficSearchRequest 类。
  130. */
  131. - (void)AMapRoadTrafficCircleSearch:(AMapRoadTrafficCircleSearchRequest *)request;
  132. #pragma mark - 附近搜索相关
  133. /**
  134. * @brief 附近搜索查询接口
  135. * @param request 查询选项。具体属性字段请参考 AMapNearbySearchRequest 类。
  136. */
  137. - (void)AMapNearbySearch:(AMapNearbySearchRequest *)request;
  138. #pragma mark - 云图搜索相关
  139. /**
  140. * @brief 云图周边查询接口
  141. * @param request 查询选项。具体属性字段请参考 AMapCloudPOIAroundSearchRequest 类。
  142. */
  143. - (void)AMapCloudPOIAroundSearch:(AMapCloudPOIAroundSearchRequest *)request;
  144. /**
  145. * @brief 云图polygon区域查询接口
  146. * @param request 查询选项。具体属性字段请参考 AMapCloudPOIPolygonSearchRequest 类。
  147. */
  148. - (void)AMapCloudPOIPolygonSearch:(AMapCloudPOIPolygonSearchRequest *)request;
  149. /**
  150. * @brief 云图ID查询接口
  151. * @param request 查询选项。具体属性字段请参考 AMapCloudPOIIDSearchRequest 类。
  152. */
  153. - (void)AMapCloudPOIIDSearch:(AMapCloudPOIIDSearchRequest *)request;
  154. /**
  155. * @brief 云图本地查询接口
  156. * @param request 查询选项。具体属性字段请参考 AMapCloudPOILocalSearchRequest 类。
  157. */
  158. - (void)AMapCloudPOILocalSearch:(AMapCloudPOILocalSearchRequest *)request;
  159. #pragma mark - 短串分享相关
  160. /**
  161. * @brief 位置短串分享接口
  162. * @param request 查询选项。具体属性字段请参考 AMapLocationShareSearchRequest 类。
  163. */
  164. - (void)AMapLocationShareSearch:(AMapLocationShareSearchRequest *)request;
  165. /**
  166. * @brief 兴趣点短串分享接口
  167. * @param request 查询选项。具体属性字段请参考 AMapPOIShareSearchRequest 类。
  168. */
  169. - (void)AMapPOIShareSearch:(AMapPOIShareSearchRequest *)request;
  170. /**
  171. * @brief 路线规划短串分享接口
  172. * @param request 查询选项。具体属性字段请参考 AMapRouteShareSearchRequest 类。
  173. */
  174. - (void)AMapRouteShareSearch:(AMapRouteShareSearchRequest *)request;
  175. /**
  176. * @brief 导航短串分享接口
  177. * @param request 查询选项。具体属性字段请参考 AMapNavigationShareSearchRequest 类。
  178. */
  179. - (void)AMapNavigationShareSearch:(AMapNavigationShareSearchRequest *)request;
  180. @end
  181. #pragma mark - AMapSearchDelegate
  182. ///AMapSearchDelegate协议, 定义了搜索结果的回调方法,发生错误时的错误回调方法。
  183. @protocol AMapSearchDelegate<NSObject>
  184. @optional
  185. /**
  186. * @brief 当请求发生错误时,会调用代理的此方法.
  187. * @param request 发生错误的请求.
  188. * @param error 返回的错误.
  189. */
  190. - (void)AMapSearchRequest:(id)request didFailWithError:(NSError *)error;
  191. /**
  192. * @brief POI查询回调函数
  193. * @param request 发起的请求,具体字段参考 AMapPOISearchBaseRequest 及其子类。
  194. * @param response 响应结果,具体字段参考 AMapPOISearchResponse 。
  195. */
  196. - (void)onPOISearchDone:(AMapPOISearchBaseRequest *)request response:(AMapPOISearchResponse *)response;
  197. /**
  198. * @brief 沿途查询回调函数 (since v4.3.0)
  199. * @param request 发起的请求,具体字段参考 AMapRoutePOISearchRequest 及其子类。
  200. * @param response 响应结果,具体字段参考 AMapRoutePOISearchResponse 。
  201. */
  202. - (void)onRoutePOISearchDone:(AMapRoutePOISearchRequest *)request response:(AMapRoutePOISearchResponse *)response;
  203. /**
  204. * @brief 地理编码查询回调函数
  205. * @param request 发起的请求,具体字段参考 AMapGeocodeSearchRequest 。
  206. * @param response 响应结果,具体字段参考 AMapGeocodeSearchResponse 。
  207. */
  208. - (void)onGeocodeSearchDone:(AMapGeocodeSearchRequest *)request response:(AMapGeocodeSearchResponse *)response;
  209. /**
  210. * @brief 逆地理编码查询回调函数
  211. * @param request 发起的请求,具体字段参考 AMapReGeocodeSearchRequest 。
  212. * @param response 响应结果,具体字段参考 AMapReGeocodeSearchResponse 。
  213. */
  214. - (void)onReGeocodeSearchDone:(AMapReGeocodeSearchRequest *)request response:(AMapReGeocodeSearchResponse *)response;
  215. /**
  216. * @brief 输入提示查询回调函数
  217. * @param request 发起的请求,具体字段参考 AMapInputTipsSearchRequest 。
  218. * @param response 响应结果,具体字段参考 AMapInputTipsSearchResponse 。
  219. */
  220. - (void)onInputTipsSearchDone:(AMapInputTipsSearchRequest *)request response:(AMapInputTipsSearchResponse *)response;
  221. /**
  222. * @brief 公交站查询回调函数
  223. * @param request 发起的请求,具体字段参考 AMapBusStopSearchRequest 。
  224. * @param response 响应结果,具体字段参考 AMapBusStopSearchResponse 。
  225. */
  226. - (void)onBusStopSearchDone:(AMapBusStopSearchRequest *)request response:(AMapBusStopSearchResponse *)response;
  227. /**
  228. * @brief 公交线路关键字查询回调
  229. * @param request 发起的请求,具体字段参考 AMapBusLineSearchRequest 。
  230. * @param response 响应结果,具体字段参考 AMapBusLineSearchResponse 。
  231. */
  232. - (void)onBusLineSearchDone:(AMapBusLineBaseSearchRequest *)request response:(AMapBusLineSearchResponse *)response;
  233. /**
  234. * @brief 行政区域查询回调函数
  235. * @param request 发起的请求,具体字段参考 AMapDistrictSearchRequest 。
  236. * @param response 响应结果,具体字段参考 AMapDistrictSearchResponse 。
  237. */
  238. - (void)onDistrictSearchDone:(AMapDistrictSearchRequest *)request response:(AMapDistrictSearchResponse *)response;
  239. /**
  240. * @brief 路径规划查询回调
  241. * @param request 发起的请求,具体字段参考 AMapRouteSearchBaseRequest 及其子类。
  242. * @param response 响应结果,具体字段参考 AMapRouteSearchResponse 。
  243. */
  244. - (void)onRouteSearchDone:(AMapRouteSearchBaseRequest *)request response:(AMapRouteSearchResponse *)response;
  245. /**
  246. * @brief 天气查询回调
  247. * @param request 发起的请求,具体字段参考 AMapWeatherSearchRequest 。
  248. * @param response 响应结果,具体字段参考 AMapWeatherSearchResponse 。
  249. */
  250. - (void)onWeatherSearchDone:(AMapWeatherSearchRequest *)request response:(AMapWeatherSearchResponse *)response;
  251. /**
  252. * @brief 道路路况查询回调 since 5.1.0
  253. * @param request 发起的请求,具体字段参考 AMapRoadTrafficSearchBaseRequest 及其子类 。
  254. * @param response 响应结果,具体字段参考 AMapRoadTrafficSearchResponse 。
  255. */
  256. - (void)onRoadTrafficSearchDone:(AMapRoadTrafficSearchBaseRequest *)request response:(AMapRoadTrafficSearchResponse *)response;
  257. #pragma mark - 附近搜索回调
  258. /**
  259. * @brief 附近搜索回调
  260. * @param request 发起的请求,具体字段参考 AMapNearbySearchRequest 。
  261. * @param response 响应结果,具体字段参考 AMapNearbySearchResponse 。
  262. */
  263. - (void)onNearbySearchDone:(AMapNearbySearchRequest *)request response:(AMapNearbySearchResponse *)response;
  264. #pragma mark - 云图搜索回调
  265. /**
  266. * @brief 云图查询回调函数
  267. * @param request 发起的请求,具体字段参考 AMapCloudSearchBaseRequest 。
  268. * @param response 响应结果,具体字段参考 AMapCloudPOISearchResponse 。
  269. */
  270. - (void)onCloudSearchDone:(AMapCloudSearchBaseRequest *)request response:(AMapCloudPOISearchResponse *)response;
  271. #pragma mark - 短串分享搜索回调
  272. /**
  273. * @brief 短串分享搜索回调
  274. * @param request 发起的请求
  275. * @param response 相应结果,具体字段参考 AMapShareSearchResponse。
  276. */
  277. - (void)onShareSearchDone:(AMapShareSearchBaseRequest *)request response:(AMapShareSearchResponse *)response;
  278. @end