iOS高德地图SDK(搜索)  V7.4.0
AMapSearchObj.h
Go to the documentation of this file.
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 /* 该文件定义了搜索请求和返回对象。*/
10 
11 #import <Foundation/Foundation.h>
12 #import "AMapCommonObj.h"
13 
15 typedef NS_ENUM(NSInteger, AMapRoutePOISearchType)
16 {
23 };
24 
26 typedef NS_ENUM(NSInteger, AMapWeatherType)
27 {
30 };
31 
33 typedef NS_ENUM(NSInteger, AMapCloudSortType)
34 {
37 };
38 
40 typedef NS_ENUM(NSInteger, AMapNearbySearchType)
41 {
44 };
45 
47 typedef NS_ENUM(NSInteger, AMapTruckSizeType)
48 {
53 };
54 
56 typedef NS_ENUM(NSInteger, AMapDrivingRouteExcludeType)
57 {
62 };
63 
64 #pragma mark - AMapPOISearchBaseRequest
65 
69 @property (nonatomic, copy) NSString *types;
71 @property (nonatomic, assign) NSInteger sortrule;
73 @property (nonatomic, assign) NSInteger offset;
75 @property (nonatomic, assign) NSInteger page;
77 @property (nonatomic, copy) NSString *building;
79 @property (nonatomic, assign) BOOL requireExtension;
81 @property (nonatomic, assign) BOOL requireSubPOIs;
82 @end
83 
87 @property (nonatomic, copy) NSString *uid;
88 @end
89 
93 @property (nonatomic, copy) NSString *keywords;
95 @property (nonatomic, copy) NSString *city;
97 @property (nonatomic, assign) BOOL cityLimit;
99 @property (nonatomic, strong) AMapGeoPoint *location;
100 
101 @end
102 
106 @property (nonatomic, copy) NSString *keywords;
108 @property (nonatomic, copy) AMapGeoPoint *location;
110 @property (nonatomic, assign) NSInteger radius;
112 @property (nonatomic, copy) NSString *city;
113 
114 @end
115 
119 @property (nonatomic, copy) NSString *keywords;
121 @property (nonatomic, copy) AMapGeoPolygon *polygon;
122 @end
123 
127 @property (nonatomic, assign) NSInteger count;
129 @property (nonatomic, strong) AMapSuggestion *suggestion;
131 @property (nonatomic, strong) NSArray<AMapPOI *> *pois;
132 @end
133 
134 #pragma mark - AMapPOIRouteSearchRequest
138 @property (nonatomic, copy) AMapGeoPoint *origin;
140 @property (nonatomic, copy) AMapGeoPoint *destination;
142 @property (nonatomic, assign) AMapRoutePOISearchType searchType;
144 @property (nonatomic, assign) NSInteger strategy;
146 @property (nonatomic, assign) NSInteger range;
148 @property (nonatomic, strong) NSString *polylineStr;
150 @property (nonatomic, strong) NSArray<AMapGeoPoint*> *polyline;
151 
152 @end
153 
157 @property (nonatomic, assign) NSInteger count;
159 @property (nonatomic, strong) NSArray<AMapRoutePOI *> *pois;
160 @end
161 
162 #pragma mark - AMapInputTipsSearchRequest
163 
167 @property (nonatomic, copy) NSString *keywords;
169 @property (nonatomic, copy) NSString *city;
171 @property (nonatomic, copy) NSString *types;
173 @property (nonatomic, assign) BOOL cityLimit;
175 @property (nonatomic, copy) NSString *location;
176 @end
177 
181 @property (nonatomic, assign) NSInteger count;
183 @property (nonatomic, strong) NSArray<AMapTip *> *tips;
184 @end
185 
186 #pragma mark - AMapGeocodeSearchRequest
187 
191 @property (nonatomic, copy) NSString *address;
193 @property (nonatomic, copy) NSString *city;
195 @property (nonatomic, copy) NSString *country;
196 @end
197 
201 @property (nonatomic, assign) NSInteger count;
203 @property (nonatomic, strong) NSArray<AMapGeocode *> *geocodes;
204 @end
205 
206 
207 #pragma mark - AMapReGeocodeSearchRequest
208 
212 @property (nonatomic, assign) BOOL requireExtension;
214 @property (nonatomic, copy) AMapGeoPoint *location;
216 @property (nonatomic, assign) NSInteger radius;
218 @property (nonatomic, copy) NSString *poitype;
220 @property (nonatomic, copy) NSString *mode;
221 
222 @end
223 
227 @property (nonatomic, strong) AMapReGeocode *regeocode;
228 @end
229 
230 #pragma mark - AMapBusStopSearchRequest
231 
235 @property (nonatomic, copy) NSString *keywords;
237 @property (nonatomic, copy) NSString *city;
239 @property (nonatomic, assign) NSInteger offset;
241 @property (nonatomic, assign) NSInteger page;
242 @end
243 
247 @property (nonatomic, assign) NSInteger count;
249 @property (nonatomic, strong) AMapSuggestion *suggestion;
251 @property (nonatomic, strong) NSArray<AMapBusStop *> *busstops;
252 @end
253 
254 #pragma mark - AMapBusLineSearchRequest
255 
259 @property (nonatomic, copy) NSString *city;
261 @property (nonatomic, assign) BOOL requireExtension;
263 @property (nonatomic, assign) NSInteger offset;
265 @property (nonatomic, assign) NSInteger page;
266 @end
267 
271 @property (nonatomic, copy) NSString *keywords;
272 @end
273 
277 @property (nonatomic, copy) NSString *uid;
278 @end
279 
283 @property (nonatomic, assign) NSInteger count;
285 @property (nonatomic, strong) AMapSuggestion *suggestion;
287 @property (nonatomic, strong) NSArray<AMapBusLine *> *buslines;
288 @end
289 
290 #pragma mark - AMapDistrictSearchRequest
294 @property (nonatomic, copy) NSString *keywords;
296 @property (nonatomic, assign) BOOL requireExtension;
298 @property (nonatomic, assign) BOOL showBusinessArea __attribute__((deprecated("已废弃, from 5.3.0")));;
300 @property (nonatomic, assign) NSInteger offset;
302 @property (nonatomic, assign) NSInteger page;
304 @property (nonatomic, assign) NSInteger subdistrict;
305 
306 @end
307 
311 @property (nonatomic, assign) NSInteger count;
313 @property (nonatomic, strong) NSArray<AMapDistrict *> *districts;
314 @end
315 
316 #pragma mark - AMapRouteSearchBaseRequest
317 
321 @property (nonatomic, copy) AMapGeoPoint *origin;
323 @property (nonatomic, copy) AMapGeoPoint *destination;
324 @end
325 
326 #pragma mark - AMapDrivingRouteSearchRequest
327 
330 
348 @property (nonatomic, assign) NSInteger strategy;
350 @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
352 @property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
354 @property (nonatomic, copy) NSString *avoidroad;
356 @property (nonatomic, copy) NSString *originId;
358 @property (nonatomic, copy) NSString *destinationId;
360 @property (nonatomic, copy) NSString *origintype;
362 @property (nonatomic, copy) NSString *destinationtype;
364 @property (nonatomic, assign) BOOL requireExtension;
366 @property (nonatomic, copy) NSString *plateProvince;
368 @property (nonatomic, copy) NSString *plateNumber;
370 @property (nonatomic, assign) NSInteger ferry;
377 @property (nonatomic, assign) NSInteger cartype;
379 @property (nonatomic, assign) AMapDrivingRouteExcludeType exclude;
380 
381 @end
382 
383 #pragma mark - AMapWalkingRouteSearchRequest
384 
388 @property (nonatomic, assign) NSInteger multipath __attribute__((deprecated("已废弃, from 5.0.0")));
389 @end
390 
391 #pragma mark - AMapTransitRouteSearchRequest
392 
396 @property (nonatomic, assign) NSInteger strategy;
398 @property (nonatomic, copy) NSString *city;
400 @property (nonatomic, copy) NSString *destinationCity;
402 @property (nonatomic, assign) BOOL nightflag;
404 @property (nonatomic, assign) BOOL requireExtension;
405 @end
406 
407 #pragma mark - AMapRidingRouteSearchRequest
408 
412 @property (nonatomic, assign) NSInteger type __attribute__((deprecated("已废弃, from 5.0.0")));
413 @end
414 
418 @property (nonatomic, assign) NSInteger count;
420 @property (nonatomic, strong) AMapRoute *route;
421 @end
422 
425 @end
426 
427 #pragma mark - AMapTruckRouteSearchRequest
428 
431 
444 @property (nonatomic, assign) NSInteger strategy;
446 @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
448 @property (nonatomic, copy) NSString *originId;
450 @property (nonatomic, copy) NSString *destinationId;
452 @property (nonatomic, copy) NSString *origintype;
454 @property (nonatomic, copy) NSString *destinationtype;
456 @property (nonatomic, copy) NSString *plateProvince;
458 @property (nonatomic, copy) NSString *plateNumber;
460 @property (nonatomic, assign) AMapTruckSizeType size;
462 @property (nonatomic, assign) CGFloat height;
464 @property (nonatomic, assign) CGFloat width;
466 @property (nonatomic, assign) CGFloat load;
468 @property (nonatomic, assign) CGFloat weight;
470 @property (nonatomic, assign) NSInteger axis;
471 
472 @end
473 
474 #pragma mark - AMapDistanceSearchRequest
475 
479 @property (nonatomic, strong) NSArray<AMapGeoPoint *> *origins;
481 @property (nonatomic, strong) AMapGeoPoint *destination;
483 @property (nonatomic, assign) NSInteger type;
484 
485 @end
486 
490 @property (nonatomic, strong) NSArray<AMapDistanceResult *> *results;
491 
492 @end
493 
494 #pragma mark - AMapWeatherSearchRequest
495 
499 @property (nonatomic, copy) NSString *city;
501 @property (nonatomic, assign) AMapWeatherType type;
502 @end
503 
507 @property (nonatomic, strong) NSArray<AMapLocalWeatherLive *> *lives;
509 @property (nonatomic, strong) NSArray<AMapLocalWeatherForecast *> *forecasts;
510 
511 @end
512 
513 #pragma mark - AMapRoadTrafficSearchRequest
514 
516 
518 @property (nonatomic, assign) NSInteger level;
519 
521 @property (nonatomic, assign) BOOL requireExtension;
522 
523 @end
524 
527 
529 @property (nonatomic, copy) NSString *roadName;
530 
532 @property (nonatomic, copy) NSString *adcode;
533 
534 @end
535 
538 
540 @property (nonatomic, copy) AMapGeoPoint *location;
542 @property (nonatomic, assign) NSInteger radius;
543 
544 @end
545 
549 @property (nonatomic, strong) AMapTrafficInfo *trafficInfo;
550 
551 @end
552 
553 #pragma mark - AMapNearbySearchRequest
557 @property (nonatomic, copy) AMapGeoPoint *center;
559 @property (nonatomic, assign) NSInteger radius;
561 @property (nonatomic, assign) AMapNearbySearchType searchType;
563 @property (nonatomic, assign) NSInteger timeRange;
565 @property (nonatomic, assign) NSInteger limit;
566 @end
567 
571 @property (nonatomic, assign) NSInteger count;
573 @property (nonatomic, strong) NSArray<AMapNearbyUserInfo *> *infos;
574 @end
575 
576 #pragma mark - AMapCloudSearchBaseRequest
577 
581 @property (nonatomic, copy) NSString *tableID;
583 @property (nonatomic, strong) NSArray<NSString *> *filter;
585 @property (nonatomic, copy) NSString *sortFields;
587 @property (nonatomic, assign) AMapCloudSortType sortType;
589 @property (nonatomic, assign) NSInteger offset;
591 @property (nonatomic, assign) NSInteger page;
592 @end
593 
594 #pragma mark - AMapCloudPlaceAroundSearchRequest
595 
599 @property (nonatomic, copy) AMapGeoPoint *center;
601 @property (nonatomic, assign) NSInteger radius;
603 @property (nonatomic, copy) NSString *keywords;
604 @end
605 
609 @property (nonatomic, copy) AMapGeoPolygon *polygon;
611 @property (nonatomic, copy) NSString *keywords;
612 @end
613 
617 @property (nonatomic, assign) NSInteger uid;
618 @end
619 
623 @property (nonatomic, copy) NSString *keywords;
625 @property (nonatomic, copy) NSString *city;
626 @end
627 
631 @property (nonatomic, assign) NSInteger count;
633 @property (nonatomic, strong) NSArray<AMapCloudPOI *> *POIs;
634 
635 @end
636 
637 #pragma mark - AMapShareSearchBaseRequest
638 
641 @end
642 
646 @property (nonatomic, copy) AMapGeoPoint *location;
648 @property (nonatomic, copy) NSString *name;
649 @end
650 
654 @property (nonatomic, copy) NSString *uid;
656 @property (nonatomic, copy) AMapGeoPoint *location;
658 @property (nonatomic, copy) NSString *name;
660 @property (nonatomic, copy) NSString *address;
661 @end
662 
666 @property (nonatomic, assign) NSInteger strategy;
668 @property (nonatomic, assign) NSInteger type;
670 @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
672 @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
674 @property (nonatomic, copy) NSString *startName;
676 @property (nonatomic, copy) NSString *destinationName;
677 @end
678 
681 
683 @property (nonatomic, assign) NSInteger strategy;
685 @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
687 @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
688 @end
689 
693 @property (nonatomic, copy) NSString *shareURL;
694 @end
695 
699 @property (nonatomic, copy) NSString *beginTime;
701 @property (nonatomic, assign) NSInteger interval;
703 @property (nonatomic, assign) NSInteger timeCount;
718 @property (nonatomic, assign) NSInteger strategy;
720 @property (nonatomic, copy) NSString *originId;
722 @property (nonatomic, copy) NSString *destinationId;
724 @property (nonatomic, copy) NSString *origintype;
726 @property (nonatomic, copy) NSString *destinationtype;
728 @property (nonatomic, copy) NSString *parentId;
729 
731 //@property (nonatomic, assign) BOOL requireExtension;
733 @property (nonatomic, copy) NSString *plateProvince;
735 @property (nonatomic, copy) NSString *plateNumber;
742 @property (nonatomic, assign) NSInteger cartype;
743 @end
744 
748 @property (nonatomic, strong) NSArray<AMapPath *> *paths;
750 @property (nonatomic, strong) NSArray<AMapFutureTimeInfo *> *timeInfos;
751 @end
逆地理编码请求
Definition: AMapSearchObj.h:210
加油站
Definition: AMapSearchObj.h:17
渡船
Definition: AMapSearchObj.h:61
POI ID搜索请求
Definition: AMapSearchObj.h:85
NSInteger sortrule
排序规则, 0-距离排序;1-综合排序, 默认0
Definition: AMapSearchObj.h:71
服务区
Definition: AMapSearchObj.h:22
AMapDrivingRouteExcludeType
规避道路类型
Definition: AMapSearchObj.h:56
路径规划短串分享请求
Definition: AMapSearchObj.h:664
搜索提示返回
Definition: AMapSearchObj.h:179
公交站线路根据名字请求
Definition: AMapSearchObj.h:269
道路实时路况查询请求 since 5.1.0
Definition: AMapSearchObj.h:526
道路路况信息 since 5.1.0
Definition: AMapCommonObj.h:821
公交站点返回
Definition: AMapSearchObj.h:245
天气查询返回
Definition: AMapSearchObj.h:505
沿途搜索, 注意起点和终点不能相距太远(大概70公里),否则可能搜索结果为空
Definition: AMapSearchObj.h:136
企业地图ID查询请求
Definition: AMapSearchObj.h:615
POI搜索返回
Definition: AMapSearchObj.h:125
距离查询请求(since 6.1.0)
Definition: AMapSearchObj.h:477
沿途搜索返回
Definition: AMapSearchObj.h:155
微型车
Definition: AMapSearchObj.h:49
POI周边搜索
Definition: AMapSearchObj.h:104
AMapRoutePOISearchType
沿途搜索类型
Definition: AMapSearchObj.h:15
距离查询结果(since 6.1.0)
Definition: AMapSearchObj.h:488
POI关键字搜索
Definition: AMapSearchObj.h:91
短串分享搜索请求基类, 请使用具体的子类。
Definition: AMapSearchObj.h:640
驾车路径规划
Definition: AMapSearchObj.h:329
BOOL requireSubPOIs
是否返回子POI,默认为 NO。
Definition: AMapSearchObj.h:81
直线距离
Definition: AMapSearchObj.h:42
骑行路径规划
Definition: AMapSearchObj.h:410
骑行路径规划返回
Definition: AMapSearchObj.h:424
附近搜索返回
Definition: AMapSearchObj.h:569
未来路线规划(since 6.9.0)
Definition: AMapSearchObj.h:697
收费道路
Definition: AMapSearchObj.h:59
导航短串分享响应
Definition: AMapSearchObj.h:691
搜索SDK基础类, 通用数据结构和response支持copy和coding(since 4.4.1)。
Definition: AMapCommonObj.h:17
驾车行驶距离
Definition: AMapSearchObj.h:43
地理编码请求
Definition: AMapSearchObj.h:189
公交站点请求
Definition: AMapSearchObj.h:233
POI多边形搜索
Definition: AMapSearchObj.h:117
公交站线路返回
Definition: AMapSearchObj.h:281
企业地图搜索请求基类
Definition: AMapSearchObj.h:579
POI搜索请求基类
Definition: AMapSearchObj.h:67
降序
Definition: AMapSearchObj.h:35
公交线路查询请求基类,不可直接调用
Definition: AMapSearchObj.h:257
高速路
Definition: AMapSearchObj.h:60
AMapTruckSizeType
货车类型
Definition: AMapSearchObj.h:47
行政区划查询请求
Definition: AMapSearchObj.h:292
搜索提示请求
Definition: AMapSearchObj.h:165
经纬度, description中格式为 <经度,纬度>
Definition: AMapCommonObj.h:29
ATM.
Definition: AMapSearchObj.h:19
企业地图polygon区域查询请求
Definition: AMapSearchObj.h:607
企业地图搜索返回
Definition: AMapSearchObj.h:629
实时
Definition: AMapSearchObj.h:28
建议信息
Definition: AMapCommonObj.h:71
AMapCloudSortType
企业地图搜索结果排序
Definition: AMapSearchObj.h:33
未来路线规划(since 6.9.0)
Definition: AMapSearchObj.h:746
路径规划返回
Definition: AMapSearchObj.h:416
企业地图周边搜请求
Definition: AMapSearchObj.h:597
NSInteger page
当前页数, 范围1-100, [default = 1]
Definition: AMapSearchObj.h:75
兴趣点短串分享请求
Definition: AMapSearchObj.h:652
步行路径规划
Definition: AMapSearchObj.h:386
导航短串分享请求
Definition: AMapSearchObj.h:680
公交站线路根据ID请求
Definition: AMapSearchObj.h:275
多边形, 当传入两个点的时候,当做矩形处理:左下-右上两个顶点;其他情况视为多边形,几个点即为几边型。 ...
Definition: AMapCommonObj.h:44
不规避
Definition: AMapSearchObj.h:58
位置短串分享请求
Definition: AMapSearchObj.h:644
路径规划信息
Definition: AMapCommonObj.h:682
NSString * types
类型,多个类型用“|”分割 可选值:文本分类、分类代码
Definition: AMapSearchObj.h:69
行政区划响应
Definition: AMapSearchObj.h:309
AMapWeatherType
天气查询类型
Definition: AMapSearchObj.h:26
重型车
Definition: AMapSearchObj.h:52
附近搜索请求
Definition: AMapSearchObj.h:555
货车路径规划(since 6.1.0)
Definition: AMapSearchObj.h:430
厕所
Definition: AMapSearchObj.h:20
NSString * building
建筑物POI编号,传入建筑物POI之后,则只在该建筑物之内进行搜索(since 4.5.0)
Definition: AMapSearchObj.h:77
公交路径规划
Definition: AMapSearchObj.h:394
中型车
Definition: AMapSearchObj.h:51
NSInteger offset
每页记录数, 范围1-50, [default = 20]
Definition: AMapSearchObj.h:73
地理编码返回
Definition: AMapSearchObj.h:199
逆地理编码返回
Definition: AMapSearchObj.h:225
路径规划基础类,不可直接调用
Definition: AMapSearchObj.h:319
逆地理编码
Definition: AMapCommonObj.h:325
加气站
Definition: AMapSearchObj.h:21
轻型车
Definition: AMapSearchObj.h:50
Definition: AMapSearchObj.h:515
AMapNearbySearchType
附近搜索距离类型
Definition: AMapSearchObj.h:40
道路实时路况查询返回 since 5.1.0
Definition: AMapSearchObj.h:547
天气查询请求
Definition: AMapSearchObj.h:497
升序
Definition: AMapSearchObj.h:36
圆形区域道路实时路况查询请求 since 5.5.0 注意:返回路况结果取决于发起请求时刻的实时路况,不保证范围内...
Definition: AMapSearchObj.h:537
维修站
Definition: AMapSearchObj.h:18
预报
Definition: AMapSearchObj.h:29
BOOL requireExtension
是否返回扩展信息,默认为 NO。
Definition: AMapSearchObj.h:79
企业地图本地查询请求
Definition: AMapSearchObj.h:621
© 2017 高德信息技术有限公司 版权所有,保留所有权利。