iOS高德地图SDK(搜索)  V8.1.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 {
17  AMapRoutePOISearchTypeGasStation = 0,
18  AMapRoutePOISearchTypeMaintenanceStation = 1,
19  AMapRoutePOISearchTypeATM = 2,
20  AMapRoutePOISearchTypeToilet = 3,
21  AMapRoutePOISearchTypeGasAirStation = 4,
22  AMapRoutePOISearchTypeParkStation = 5,
23 };
24 
26 typedef NS_ENUM(NSInteger, AMapWeatherType)
27 {
28  AMapWeatherTypeLive = 1,
29  AMapWeatherTypeForecast
30 };
31 
33 typedef NS_ENUM(NSInteger, AMapCloudSortType)
34 {
35  AMapCloudSortTypeDESC = 0,
36  AMapCloudSortTypeASC = 1
37 };
38 
40 typedef NS_ENUM(NSInteger, AMapNearbySearchType)
41 {
42  AMapNearbySearchTypeLiner = 0,
43  AMapNearbySearchTypeDriving = 1,
44 };
45 
47 typedef NS_ENUM(NSInteger, AMapTruckSizeType)
48 {
49  AMapTruckSizeTypeMini = 1,
50  AMapTruckSizeTypeLight = 2,
51  AMapTruckSizeTypeMedium = 3,
52  AMapTruckSizeTypeHeavy = 4,
53 };
54 
56 typedef NS_ENUM(NSInteger, AMapDrivingRouteExcludeType)
57 {
58  AMapDrivingRouteExcludeTypeNone = 0,
59  AMapDrivingRouteExcludeTypeToll = 1,
60  AMapDrivingRouteExcludeTypeMotorway = 2,
61  AMapDrivingRouteExcludeTypeFerry = 3,
62 };
63 
65 typedef NS_ENUM(NSInteger, AMapDistanceSearchType)
66 {
67  AMapDistanceSearchTypeStraight = 0,
68  AMapDistanceSearchTypeDrive = 1,
69  AMapDistanceSearchTypeWalk = 3,
70 };
71 
72 #pragma mark - AMapPOISearchBaseRequest
73 
77 @property (nonatomic, copy) NSString *types;
79 @property (nonatomic, assign) NSInteger sortrule;
81 @property (nonatomic, assign) NSInteger offset;
83 @property (nonatomic, assign) NSInteger page;
85 @property (nonatomic, copy) NSString *building;
87 @property (nonatomic, assign) BOOL requireExtension;
89 @property (nonatomic, assign) BOOL requireSubPOIs;
90 @end
91 
95 @property (nonatomic, copy) NSString *uid;
96 @end
97 
101 @property (nonatomic, copy) NSString *keywords;
103 @property (nonatomic, copy) NSString *city;
105 @property (nonatomic, assign) BOOL cityLimit;
107 @property (nonatomic, strong) AMapGeoPoint *location;
108 
109 @end
110 
114 @property (nonatomic, copy) NSString *keywords;
116 @property (nonatomic, copy) AMapGeoPoint *location;
118 @property (nonatomic, assign) NSInteger radius;
120 @property (nonatomic, copy) NSString *city;
122 @property (nonatomic, assign) BOOL special;
123 
124 @end
125 
129 @property (nonatomic, copy) NSString *keywords;
131 @property (nonatomic, copy) AMapGeoPolygon *polygon;
132 @end
133 
137 @property (nonatomic, assign) NSInteger count;
139 @property (nonatomic, strong) AMapSuggestion *suggestion;
141 @property (nonatomic, strong) NSArray<AMapPOI *> *pois;
142 @end
143 
144 #pragma mark - AMapPOIRouteSearchRequest
148 @property (nonatomic, copy) AMapGeoPoint *origin;
150 @property (nonatomic, copy) AMapGeoPoint *destination;
152 @property (nonatomic, assign) AMapRoutePOISearchType searchType;
154 @property (nonatomic, assign) NSInteger strategy;
156 @property (nonatomic, assign) NSInteger range;
158 @property (nonatomic, strong) NSString *polylineStr;
160 @property (nonatomic, strong) NSArray<AMapGeoPoint*> *polyline;
161 
162 @end
163 
167 @property (nonatomic, assign) NSInteger count;
169 @property (nonatomic, strong) NSArray<AMapRoutePOI *> *pois;
170 @end
171 
172 #pragma mark - AMapInputTipsSearchRequest
173 
177 @property (nonatomic, copy) NSString *keywords;
179 @property (nonatomic, copy) NSString *city;
181 @property (nonatomic, copy) NSString *types;
183 @property (nonatomic, assign) BOOL cityLimit;
185 @property (nonatomic, copy) NSString *location;
186 @end
187 
191 @property (nonatomic, assign) NSInteger count;
193 @property (nonatomic, strong) NSArray<AMapTip *> *tips;
194 @end
195 
196 #pragma mark - AMapGeocodeSearchRequest
197 
201 @property (nonatomic, copy) NSString *address;
203 @property (nonatomic, copy) NSString *city;
205 @property (nonatomic, copy) NSString *country;
206 @end
207 
211 @property (nonatomic, assign) NSInteger count;
213 @property (nonatomic, strong) NSArray<AMapGeocode *> *geocodes;
214 @end
215 
216 
217 #pragma mark - AMapReGeocodeSearchRequest
218 
222 @property (nonatomic, assign) BOOL requireExtension;
224 @property (nonatomic, copy) AMapGeoPoint *location;
226 @property (nonatomic, assign) NSInteger radius;
228 @property (nonatomic, copy) NSString *poitype;
230 @property (nonatomic, copy) NSString *mode;
231 
232 @end
233 
237 @property (nonatomic, strong) AMapReGeocode *regeocode;
238 @end
239 
240 #pragma mark - AMapBusStopSearchRequest
241 
245 @property (nonatomic, copy) NSString *keywords;
247 @property (nonatomic, copy) NSString *city;
249 @property (nonatomic, assign) NSInteger offset;
251 @property (nonatomic, assign) NSInteger page;
252 @end
253 
257 @property (nonatomic, assign) NSInteger count;
259 @property (nonatomic, strong) AMapSuggestion *suggestion;
261 @property (nonatomic, strong) NSArray<AMapBusStop *> *busstops;
262 @end
263 
264 #pragma mark - AMapBusLineSearchRequest
265 
269 @property (nonatomic, copy) NSString *city;
271 @property (nonatomic, assign) BOOL requireExtension;
273 @property (nonatomic, assign) NSInteger offset;
275 @property (nonatomic, assign) NSInteger page;
276 @end
277 
281 @property (nonatomic, copy) NSString *keywords;
282 @end
283 
287 @property (nonatomic, copy) NSString *uid;
288 @end
289 
293 @property (nonatomic, assign) NSInteger count;
295 @property (nonatomic, strong) AMapSuggestion *suggestion;
297 @property (nonatomic, strong) NSArray<AMapBusLine *> *buslines;
298 @end
299 
300 #pragma mark - AMapDistrictSearchRequest
304 @property (nonatomic, copy) NSString *keywords;
306 @property (nonatomic, assign) BOOL requireExtension;
308 @property (nonatomic, assign) BOOL showBusinessArea __attribute__((deprecated("已废弃, from 5.3.0")));;
310 @property (nonatomic, assign) NSInteger offset;
312 @property (nonatomic, assign) NSInteger page;
314 @property (nonatomic, assign) NSInteger subdistrict;
315 
316 @end
317 
321 @property (nonatomic, assign) NSInteger count;
323 @property (nonatomic, strong) NSArray<AMapDistrict *> *districts;
324 @end
325 
326 #pragma mark - AMapRouteSearchBaseRequest
327 
331 @property (nonatomic, copy) AMapGeoPoint *origin;
333 @property (nonatomic, copy) AMapGeoPoint *destination;
334 @end
335 
336 #pragma mark - AMapDrivingRouteSearchRequest
337 
340 
358 @property (nonatomic, assign) NSInteger strategy;
360 @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
362 @property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
364 @property (nonatomic, copy) NSString *avoidroad;
366 @property (nonatomic, copy) NSString *originId;
368 @property (nonatomic, copy) NSString *destinationId;
370 @property (nonatomic, copy) NSString *origintype;
372 @property (nonatomic, copy) NSString *destinationtype;
374 @property (nonatomic, assign) BOOL requireExtension;
376 @property (nonatomic, copy) NSString *plateProvince;
378 @property (nonatomic, copy) NSString *plateNumber;
380 @property (nonatomic, assign) NSInteger ferry;
387 @property (nonatomic, assign) NSInteger cartype;
389 @property (nonatomic, assign) AMapDrivingRouteExcludeType exclude;
390 
391 @end
392 
393 #pragma mark - AMapWalkingRouteSearchRequest
394 
398 @property (nonatomic, assign) NSInteger multipath __attribute__((deprecated("已废弃, from 5.0.0")));
399 @end
400 
401 #pragma mark - AMapTransitRouteSearchRequest
402 
406 @property (nonatomic, assign) NSInteger strategy;
408 @property (nonatomic, copy) NSString *city;
410 @property (nonatomic, copy) NSString *destinationCity;
412 @property (nonatomic, assign) BOOL nightflag;
414 @property (nonatomic, assign) BOOL requireExtension;
415 @end
416 
417 #pragma mark - AMapRidingRouteSearchRequest
418 
422 @property (nonatomic, assign) NSInteger type __attribute__((deprecated("已废弃, from 5.0.0")));
424 @property (nonatomic, assign) BOOL requireExtension;
425 @end
426 
430 @property (nonatomic, assign) NSInteger count;
432 @property (nonatomic, strong) AMapRoute *route;
433 @end
434 
437 @end
438 
439 #pragma mark - AMapTruckRouteSearchRequest
440 
443 
456 @property (nonatomic, assign) NSInteger strategy;
458 @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
460 @property (nonatomic, copy) NSString *originId;
462 @property (nonatomic, copy) NSString *destinationId;
464 @property (nonatomic, copy) NSString *origintype;
466 @property (nonatomic, copy) NSString *destinationtype;
468 @property (nonatomic, copy) NSString *plateProvince;
470 @property (nonatomic, copy) NSString *plateNumber;
472 @property (nonatomic, assign) AMapTruckSizeType size;
474 @property (nonatomic, assign) CGFloat height;
476 @property (nonatomic, assign) CGFloat width;
478 @property (nonatomic, assign) CGFloat load;
480 @property (nonatomic, assign) CGFloat weight;
482 @property (nonatomic, assign) NSInteger axis;
484 @property (nonatomic, assign) BOOL requireExtension;
485 @end
486 
487 #pragma mark - AMapDistanceSearchRequest
488 
492 @property (nonatomic, strong) NSArray<AMapGeoPoint *> *origins;
494 @property (nonatomic, strong) AMapGeoPoint *destination;
496 @property (nonatomic, assign) AMapDistanceSearchType type;
498 @property (nonatomic, assign) NSInteger strategy;
500 @property (nonatomic, assign) BOOL requireExtension;
501 @end
502 
506 @property (nonatomic, strong) NSArray<AMapDistanceResult *> *results;
507 
508 @end
509 
510 #pragma mark - AMapWeatherSearchRequest
511 
515 @property (nonatomic, copy) NSString *city;
517 @property (nonatomic, assign) AMapWeatherType type;
518 @end
519 
523 @property (nonatomic, strong) NSArray<AMapLocalWeatherLive *> *lives;
525 @property (nonatomic, strong) NSArray<AMapLocalWeatherForecast *> *forecasts;
526 
527 @end
528 
529 #pragma mark - AMapNearbySearchRequest
533 @property (nonatomic, copy) AMapGeoPoint *center;
535 @property (nonatomic, assign) NSInteger radius;
537 @property (nonatomic, assign) AMapNearbySearchType searchType;
539 @property (nonatomic, assign) NSInteger timeRange;
541 @property (nonatomic, assign) NSInteger limit;
542 @end
543 
547 @property (nonatomic, assign) NSInteger count;
549 @property (nonatomic, strong) NSArray<AMapNearbyUserInfo *> *infos;
550 @end
551 
552 #pragma mark - AMapCloudSearchBaseRequest
553 
557 @property (nonatomic, copy) NSString *tableID;
559 @property (nonatomic, strong) NSArray<NSString *> *filter;
561 @property (nonatomic, copy) NSString *sortFields;
563 @property (nonatomic, assign) AMapCloudSortType sortType;
565 @property (nonatomic, assign) NSInteger offset;
567 @property (nonatomic, assign) NSInteger page;
568 @end
569 
570 #pragma mark - AMapCloudPlaceAroundSearchRequest
571 
575 @property (nonatomic, copy) AMapGeoPoint *center;
577 @property (nonatomic, assign) NSInteger radius;
579 @property (nonatomic, copy) NSString *keywords;
580 @end
581 
585 @property (nonatomic, copy) AMapGeoPolygon *polygon;
587 @property (nonatomic, copy) NSString *keywords;
588 @end
589 
593 @property (nonatomic, assign) NSInteger uid;
594 @end
595 
599 @property (nonatomic, copy) NSString *keywords;
601 @property (nonatomic, copy) NSString *city;
602 @end
603 
607 @property (nonatomic, assign) NSInteger count;
609 @property (nonatomic, strong) NSArray<AMapCloudPOI *> *POIs;
610 
611 @end
612 
613 #pragma mark - AMapShareSearchBaseRequest
614 
617 @end
618 
622 @property (nonatomic, copy) AMapGeoPoint *location;
624 @property (nonatomic, copy) NSString *name;
625 @end
626 
630 @property (nonatomic, copy) NSString *uid;
632 @property (nonatomic, copy) AMapGeoPoint *location;
634 @property (nonatomic, copy) NSString *name;
636 @property (nonatomic, copy) NSString *address;
637 @end
638 
642 @property (nonatomic, assign) NSInteger strategy;
644 @property (nonatomic, assign) NSInteger type;
646 @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
648 @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
650 @property (nonatomic, copy) NSString *startName;
652 @property (nonatomic, copy) NSString *destinationName;
653 @end
654 
657 
659 @property (nonatomic, assign) NSInteger strategy;
661 @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
663 @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
664 @end
665 
669 @property (nonatomic, copy) NSString *shareURL;
670 @end
671 
675 @property (nonatomic, copy) NSString *beginTime;
677 @property (nonatomic, assign) NSInteger interval;
679 @property (nonatomic, assign) NSInteger timeCount;
694 @property (nonatomic, assign) NSInteger strategy;
696 @property (nonatomic, copy) NSString *originId;
698 @property (nonatomic, copy) NSString *destinationId;
700 @property (nonatomic, copy) NSString *origintype;
702 @property (nonatomic, copy) NSString *destinationtype;
704 @property (nonatomic, copy) NSString *parentId;
705 
707 //@property (nonatomic, assign) BOOL requireExtension;
709 @property (nonatomic, copy) NSString *plateProvince;
711 @property (nonatomic, copy) NSString *plateNumber;
718 @property (nonatomic, assign) NSInteger cartype;
719 @end
720 
724 @property (nonatomic, strong) NSArray<AMapPath *> *paths;
726 @property (nonatomic, strong) NSArray<AMapFutureTimeInfo *> *timeInfos;
727 @end
AMapPOIShareSearchRequest
兴趣点短串分享请求
Definition: AMapSearchObj.h:629
AMapRoutePOISearchRequest
沿途搜索, 注意起点和终点不能相距太远(大概70公里),否则可能搜索结果为空
Definition: AMapSearchObj.h:147
AMapPOIPolygonSearchRequest
POI多边形搜索
Definition: AMapSearchObj.h:128
AMapLocationShareSearchRequest
位置短串分享请求
Definition: AMapSearchObj.h:621
AMapShareSearchBaseRequest
短串分享搜索请求基类, 请使用具体的子类。
Definition: AMapSearchObj.h:617
AMapPOISearchBaseRequest::offset
NSInteger offset
每页记录数, 范围1-25, [default = 20]
Definition: AMapSearchObj.h:81
AMapReGeocodeSearchResponse
逆地理编码返回
Definition: AMapSearchObj.h:236
AMapNearbySearchResponse
附近搜索返回
Definition: AMapSearchObj.h:546
AMapPOISearchBaseRequest::page
NSInteger page
当前页数, 范围1-100, [default = 1]
Definition: AMapSearchObj.h:83
AMapInputTipsSearchRequest
搜索提示请求
Definition: AMapSearchObj.h:176
AMapCloudPOIPolygonSearchRequest
企业地图polygon区域查询请求
Definition: AMapSearchObj.h:584
AMapPOISearchBaseRequest::types
NSString * types
类型,多个类型用“|”分割 可选值:文本分类、分类代码
Definition: AMapSearchObj.h:77
AMapBusLineNameSearchRequest
公交站线路根据名字请求
Definition: AMapSearchObj.h:280
AMapRidingRouteSearchResponse
骑行路径规划返回
Definition: AMapSearchObj.h:437
AMapBusLineSearchResponse
公交站线路返回
Definition: AMapSearchObj.h:292
AMapDrivingRouteSearchRequest
驾车路径规划
Definition: AMapSearchObj.h:340
AMapPOISearchBaseRequest
POI搜索请求基类
Definition: AMapSearchObj.h:76
AMapGeocodeSearchResponse
地理编码返回
Definition: AMapSearchObj.h:210
AMapNavigationShareSearchRequest
导航短串分享请求
Definition: AMapSearchObj.h:657
AMapPOIIDSearchRequest
POI ID搜索请求
Definition: AMapSearchObj.h:94
AMapRidingRouteSearchRequest
骑行路径规划
Definition: AMapSearchObj.h:421
AMapRouteShareSearchRequest
路径规划短串分享请求
Definition: AMapSearchObj.h:641
AMapDistrictSearchRequest
行政区划查询请求
Definition: AMapSearchObj.h:303
AMapPOISearchBaseRequest::sortrule
NSInteger sortrule
排序规则, 0-距离排序;1-综合排序, 默认0
Definition: AMapSearchObj.h:79
AMapRoute
路径规划信息
Definition: AMapCommonObj.h:683
AMapFutureRouteSearchRequest
未来路线规划(since 6.9.0)
Definition: AMapSearchObj.h:674
AMapReGeocodeSearchRequest
逆地理编码请求
Definition: AMapSearchObj.h:221
AMapFutureRouteSearchResponse
未来路线规划(since 6.9.0)
Definition: AMapSearchObj.h:723
AMapCloudPOISearchResponse
企业地图搜索返回
Definition: AMapSearchObj.h:606
AMapPOISearchBaseRequest::building
NSString * building
建筑物POI编号,传入建筑物POI之后,则只在该建筑物之内进行搜索(since 4.5.0)
Definition: AMapSearchObj.h:85
AMapSuggestion
建议信息
Definition: AMapCommonObj.h:72
AMapPOISearchBaseRequest::requireExtension
BOOL requireExtension
是否返回扩展信息,默认为 NO。
Definition: AMapSearchObj.h:87
AMapBusLineIDSearchRequest
公交站线路根据ID请求
Definition: AMapSearchObj.h:286
AMapGeocodeSearchRequest
地理编码请求
Definition: AMapSearchObj.h:200
AMapDistanceSearchResponse
距离查询结果(since 6.1.0)
Definition: AMapSearchObj.h:505
AMapGeoPolygon
多边形, 当传入两个点的时候,当做矩形处理:左下-右上两个顶点;其他情况视为多边形,几个点即为几边型。
Definition: AMapCommonObj.h:45
AMapWeatherSearchRequest
天气查询请求
Definition: AMapSearchObj.h:514
AMapBusLineBaseSearchRequest
公交线路查询请求基类,不可直接调用
Definition: AMapSearchObj.h:268
AMapShareSearchResponse
导航短串分享响应
Definition: AMapSearchObj.h:668
AMapCloudPOIAroundSearchRequest
企业地图周边搜请求
Definition: AMapSearchObj.h:574
AMapDistrictSearchResponse
行政区划响应
Definition: AMapSearchObj.h:320
AMapBusStopSearchRequest
公交站点请求
Definition: AMapSearchObj.h:244
AMapPOISearchBaseRequest::requireSubPOIs
BOOL requireSubPOIs
是否返回子POI,默认为 NO。
Definition: AMapSearchObj.h:89
AMapRouteSearchResponse
路径规划返回
Definition: AMapSearchObj.h:429
AMapWeatherSearchResponse
天气查询返回
Definition: AMapSearchObj.h:522
AMapDistanceSearchRequest
距离查询请求(since 6.1.0)
Definition: AMapSearchObj.h:491
AMapSearchObject
搜索SDK基础类, 通用数据结构和response支持copy和coding(since 4.4.1)。
Definition: AMapCommonObj.h:17
AMapTruckRouteSearchRequest
货车路径规划(since 6.1.0)
Definition: AMapSearchObj.h:443
AMapPOIKeywordsSearchRequest
POI关键字搜索
Definition: AMapSearchObj.h:100
AMapRouteSearchBaseRequest
路径规划基础类,不可直接调用
Definition: AMapSearchObj.h:330
AMapRoutePOISearchResponse
沿途搜索返回
Definition: AMapSearchObj.h:166
AMapGeoPoint
经纬度, description中格式为 <经度,纬度>
Definition: AMapCommonObj.h:30
AMapPOISearchResponse
POI搜索返回
Definition: AMapSearchObj.h:136
AMapCloudPOIIDSearchRequest
企业地图ID查询请求
Definition: AMapSearchObj.h:592
AMapCloudPOILocalSearchRequest
企业地图本地查询请求
Definition: AMapSearchObj.h:598
AMapNearbySearchRequest
附近搜索请求
Definition: AMapSearchObj.h:532
AMapReGeocode
逆地理编码
Definition: AMapCommonObj.h:326
AMapPOIAroundSearchRequest
POI周边搜索
Definition: AMapSearchObj.h:113
AMapCommonObj.h
AMapTransitRouteSearchRequest
公交路径规划
Definition: AMapSearchObj.h:405
AMapCloudSearchBaseRequest
企业地图搜索请求基类
Definition: AMapSearchObj.h:556
AMapBusStopSearchResponse
公交站点返回
Definition: AMapSearchObj.h:256
AMapInputTipsSearchResponse
搜索提示返回
Definition: AMapSearchObj.h:190
AMapWalkingRouteSearchRequest
步行路径规划
Definition: AMapSearchObj.h:397
NS_ENUM
typedef NS_ENUM(NSInteger, AMapRoutePOISearchType)
沿途搜索类型
Definition: AMapSearchObj.h:15
© 2017 高德信息技术有限公司 版权所有,保留所有权利。