123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757 |
- //
- // AMapSearchObj.h
- // AMapSearchKit
- //
- // Created by xiaoming han on 15/7/22.
- // Copyright (c) 2015年 Amap. All rights reserved.
- //
- /* 该文件定义了搜索请求和返回对象。*/
- #import <Foundation/Foundation.h>
- #import "AMapCommonObj.h"
- ///沿途搜索类型
- typedef NS_ENUM(NSInteger, AMapRoutePOISearchType)
- {
- AMapRoutePOISearchTypeGasStation = 0, ///< 加油站
- AMapRoutePOISearchTypeMaintenanceStation = 1, ///< 维修站
- AMapRoutePOISearchTypeATM = 2, ///< ATM
- AMapRoutePOISearchTypeToilet = 3, ///< 厕所
- AMapRoutePOISearchTypeGasAirStation = 4, ///< 加气站
- AMapRoutePOISearchTypeParkStation = 5, ///< 服务区
- };
- ///天气查询类型
- typedef NS_ENUM(NSInteger, AMapWeatherType)
- {
- AMapWeatherTypeLive = 1, ///< 实时
- AMapWeatherTypeForecast ///< 预报
- };
- ///企业地图搜索结果排序
- typedef NS_ENUM(NSInteger, AMapCloudSortType)
- {
- AMapCloudSortTypeDESC = 0, ///< 降序
- AMapCloudSortTypeASC = 1 ///< 升序
- };
- ///附近搜索距离类型
- typedef NS_ENUM(NSInteger, AMapNearbySearchType)
- {
- AMapNearbySearchTypeLiner = 0, ///< 直线距离
- AMapNearbySearchTypeDriving = 1, ///< 驾车行驶距离
- };
- ///货车类型
- typedef NS_ENUM(NSInteger, AMapTruckSizeType)
- {
- AMapTruckSizeTypeMini = 1, ///< 微型车
- AMapTruckSizeTypeLight = 2, ///< 轻型车
- AMapTruckSizeTypeMedium = 3, ///< 中型车
- AMapTruckSizeTypeHeavy = 4, ///< 重型车
- };
- ///规避道路类型
- typedef NS_ENUM(NSInteger, AMapDrivingRouteExcludeType)
- {
- AMapDrivingRouteExcludeTypeNone = 0, ///< 不规避
- AMapDrivingRouteExcludeTypeToll = 1, ///< 收费道路
- AMapDrivingRouteExcludeTypeMotorway = 2, ///< 高速路
- AMapDrivingRouteExcludeTypeFerry = 3, ///< 渡船
- };
- #pragma mark - AMapPOISearchBaseRequest
- ///POI搜索请求基类
- @interface AMapPOISearchBaseRequest : AMapSearchObject
- ///类型,多个类型用“|”分割 可选值:文本分类、分类代码
- @property (nonatomic, copy) NSString *types;
- ///排序规则, 0-距离排序;1-综合排序, 默认0
- @property (nonatomic, assign) NSInteger sortrule;
- ///每页记录数, 范围1-50, [default = 20]
- @property (nonatomic, assign) NSInteger offset;
- ///当前页数, 范围1-100, [default = 1]
- @property (nonatomic, assign) NSInteger page;
- ///建筑物POI编号,传入建筑物POI之后,则只在该建筑物之内进行搜索(since 4.5.0)
- @property (nonatomic, copy) NSString *building;
- ///是否返回扩展信息,默认为 NO。
- @property (nonatomic, assign) BOOL requireExtension;
- ///是否返回子POI,默认为 NO。
- @property (nonatomic, assign) BOOL requireSubPOIs;
- @end
- ///POI ID搜索请求
- @interface AMapPOIIDSearchRequest : AMapPOISearchBaseRequest
- ///POI全局唯一ID
- @property (nonatomic, copy) NSString *uid;
- @end
- ///POI关键字搜索
- @interface AMapPOIKeywordsSearchRequest : AMapPOISearchBaseRequest
- ///查询关键字,多个关键字用“|”分割
- @property (nonatomic, copy) NSString *keywords;
- ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.(注:台湾省的城市一律设置为【台湾】,不具体到市。)
- @property (nonatomic, copy) NSString *city;
- ///强制城市限制功能 默认NO,例如:在上海搜索天安门,如果citylimit为true,将不返回北京的天安门相关的POI
- @property (nonatomic, assign) BOOL cityLimit;
- ///设置后,如果sortrule==0,则返回结果会按照距离此点的远近来排序,since 5.2.1
- @property (nonatomic, strong) AMapGeoPoint *location;
- @end
- ///POI周边搜索
- @interface AMapPOIAroundSearchRequest : AMapPOISearchBaseRequest
- ///查询关键字,多个关键字用“|”分割
- @property (nonatomic, copy) NSString *keywords;
- ///中心点坐标
- @property (nonatomic, copy) AMapGeoPoint *location;
- ///查询半径,范围:0-50000,单位:米 [default = 3000]
- @property (nonatomic, assign) NSInteger radius;
- ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode。注:当用户指定的经纬度和city出现冲突,若范围内有用户指定city的数据,则返回相关数据,否则返回为空。(since 5.7.0)
- @property (nonatomic, copy) NSString *city;
- ///是否对结果进行人工干预,如火车站,原因为poi较为特殊,结果存在人工干预,干预结果优先,所以距离优先的排序未生效,默认为YES (since 7.4.0)
- @property (nonatomic, assign) BOOL special;
- @end
- ///POI多边形搜索
- @interface AMapPOIPolygonSearchRequest : AMapPOISearchBaseRequest
- ///查询关键字,多个关键字用“|”分割
- @property (nonatomic, copy) NSString *keywords;
- ///多边形
- @property (nonatomic, copy) AMapGeoPolygon *polygon;
- @end
- ///POI搜索返回
- @interface AMapPOISearchResponse : AMapSearchObject
- ///返回的POI数目
- @property (nonatomic, assign) NSInteger count;
- ///关键字建议列表和城市建议列表
- @property (nonatomic, strong) AMapSuggestion *suggestion;
- ///POI结果,AMapPOI 数组
- @property (nonatomic, strong) NSArray<AMapPOI *> *pois;
- @end
- #pragma mark - AMapPOIRouteSearchRequest
- ///沿途搜索, 注意起点和终点不能相距太远(大概70公里),否则可能搜索结果为空
- @interface AMapRoutePOISearchRequest : AMapSearchObject
- ///中心点坐标
- @property (nonatomic, copy) AMapGeoPoint *origin;
- ///目标点坐标
- @property (nonatomic, copy) AMapGeoPoint *destination;
- ///搜索类型
- @property (nonatomic, assign) AMapRoutePOISearchType searchType;
- ///驾车导航策略,同驾车路径规划请求的策略(5 多策略除外)
- @property (nonatomic, assign) NSInteger strategy;
- ///道路周围搜索范围,单位米,[0-500],默认250。
- @property (nonatomic, assign) NSInteger range;
- ///用户自己规划的路线,在origine、destination未填入时为必填.格式为:"经度,维度;经度,维度;...". 目前限制个数最多为100个点
- @property (nonatomic, strong) NSString *polylineStr;
- ///用户自己规划的路线,在origine、destination未填入且polylineStr未填入时为必填. 目前限制个数最多为100个点
- @property (nonatomic, strong) NSArray<AMapGeoPoint*> *polyline;
- @end
- ///沿途搜索返回
- @interface AMapRoutePOISearchResponse : AMapSearchObject
- ///返回的POI数目
- @property (nonatomic, assign) NSInteger count;
- ///POI结果,AMapRoutePOI 数组
- @property (nonatomic, strong) NSArray<AMapRoutePOI *> *pois;
- @end
- #pragma mark - AMapInputTipsSearchRequest
- ///搜索提示请求
- @interface AMapInputTipsSearchRequest : AMapSearchObject
- ///查询关键字
- @property (nonatomic, copy) NSString *keywords;
- ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.
- @property (nonatomic, copy) NSString *city;
- ///类型,多个类型用“|”分割 可选值:文本分类、分类代码
- @property (nonatomic, copy) NSString *types;
- ///强制城市限制功能,例如:在上海搜索天安门,如果citylimit为true,将不返回北京的天安门相关的POI
- @property (nonatomic, assign) BOOL cityLimit;
- ///格式形如:@"116.481488,39.990464",(经度,纬度),不可以包含空格。如果设置,在此location附近优先返回搜索关键词信息, since 5.0.0
- @property (nonatomic, copy) NSString *location;
- @end
- ///搜索提示返回
- @interface AMapInputTipsSearchResponse : AMapSearchObject
- ///返回数目
- @property (nonatomic, assign) NSInteger count;
- ///提示列表 AMapTip 数组, AMapTip 有多种属性,可根据该对象的返回信息,配合其他搜索服务使用,完善您应用的功能。如:\n 1)uid为空,location为空,该提示语为品牌词,可根据该品牌词进行POI关键词搜索。\n 2)uid不为空,location为空,为公交线路,根据uid进行公交线路查询。\n 3)uid不为空,location也不为空,是一个真实存在的POI,可直接显示在地图上。
- @property (nonatomic, strong) NSArray<AMapTip *> *tips;
- @end
- #pragma mark - AMapGeocodeSearchRequest
- ///地理编码请求
- @interface AMapGeocodeSearchRequest : AMapSearchObject
- ///地址
- @property (nonatomic, copy) NSString *address;
- ///查询城市,可选值:cityname(中文或中文全拼)、citycode、adcode.
- @property (nonatomic, copy) NSString *city;
- ///指定查询国家,支持多个国家,用“|”分隔,可选值:国家代码ISO 3166 或 global,仅海外生效(since 7.4.0)
- @property (nonatomic, copy) NSString *country;
- @end
- ///地理编码返回
- @interface AMapGeocodeSearchResponse : AMapSearchObject
- ///返回数目
- @property (nonatomic, assign) NSInteger count;
- ///地理编码结果 AMapGeocode 数组
- @property (nonatomic, strong) NSArray<AMapGeocode *> *geocodes;
- @end
- #pragma mark - AMapReGeocodeSearchRequest
- ///逆地理编码请求
- @interface AMapReGeocodeSearchRequest : AMapSearchObject
- ///是否返回扩展信息,默认NO。
- @property (nonatomic, assign) BOOL requireExtension;
- ///中心点坐标。
- @property (nonatomic, copy) AMapGeoPoint *location;
- ///查询半径,单位米,范围0~3000,默认1000。
- @property (nonatomic, assign) NSInteger radius;
- ///指定返回结果poi数组中的POI类型,在requireExtension=YES时生效。输入为typecode, 支持传入多个typecode, 多值时用“|”分割
- @property (nonatomic, copy) NSString *poitype;
- ///distance 按距离返回,score 按权重返回,仅海外生效(since 7.4.0)
- @property (nonatomic, copy) NSString *mode;
- @end
- ///逆地理编码返回
- @interface AMapReGeocodeSearchResponse : AMapSearchObject
- ///逆地理编码结果
- @property (nonatomic, strong) AMapReGeocode *regeocode;
- @end
- #pragma mark - AMapBusStopSearchRequest
- ///公交站点请求
- @interface AMapBusStopSearchRequest : AMapSearchObject
- ///查询关键字
- @property (nonatomic, copy) NSString *keywords;
- ///城市 可选值:cityname(中文或中文全拼)、citycode、adcode
- @property (nonatomic, copy) NSString *city;
- ///每页记录数,默认为20,取值为:1-50
- @property (nonatomic, assign) NSInteger offset;
- ///当前页数,默认值为1,取值为:1-100
- @property (nonatomic, assign) NSInteger page;
- @end
- ///公交站点返回
- @interface AMapBusStopSearchResponse : AMapSearchObject
- ///公交站数目
- @property (nonatomic, assign) NSInteger count;
- ///关键字建议列表和城市建议列表
- @property (nonatomic, strong) AMapSuggestion *suggestion;
- ///公交站点数组,数组中存放AMapBusStop对象
- @property (nonatomic, strong) NSArray<AMapBusStop *> *busstops;
- @end
- #pragma mark - AMapBusLineSearchRequest
- ///公交线路查询请求基类,不可直接调用
- @interface AMapBusLineBaseSearchRequest : AMapSearchObject
- ///城市 可选值:cityname(中文或中文全拼)、citycode、adcode
- @property (nonatomic, copy) NSString *city;
- ///是否返回扩展信息,默认为NO
- @property (nonatomic, assign) BOOL requireExtension;
- ///每页记录数,默认为20,取值为1-50
- @property (nonatomic, assign) NSInteger offset;
- ///当前页数,默认为1,取值为1-100
- @property (nonatomic, assign) NSInteger page;
- @end
- ///公交站线路根据名字请求
- @interface AMapBusLineNameSearchRequest : AMapBusLineBaseSearchRequest
- ///查询关键字
- @property (nonatomic, copy) NSString *keywords;
- @end
- ///公交站线路根据ID请求
- @interface AMapBusLineIDSearchRequest : AMapBusLineBaseSearchRequest
- ///唯一标识
- @property (nonatomic, copy) NSString *uid;
- @end
- ///公交站线路返回
- @interface AMapBusLineSearchResponse : AMapSearchObject
- ///返回公交站数目
- @property (nonatomic, assign) NSInteger count;
- ///关键字建议列表和城市建议列表
- @property (nonatomic, strong) AMapSuggestion *suggestion;
- ///公交线路数组,数组中存放 AMapBusLine 对象
- @property (nonatomic, strong) NSArray<AMapBusLine *> *buslines;
- @end
- #pragma mark - AMapDistrictSearchRequest
- ///行政区划查询请求
- @interface AMapDistrictSearchRequest : AMapSearchObject
- ///查询关键字,只支持单关键字搜索,全国范围
- @property (nonatomic, copy) NSString *keywords;
- ///是否返回边界坐标,默认NO
- @property (nonatomic, assign) BOOL requireExtension;
- ///是否显示商圈信息,默认NO。注:已废弃,行政区划搜索无商圈信息。
- @property (nonatomic, assign) BOOL showBusinessArea __attribute__((deprecated("已废弃, from 5.3.0")));;
- ///每页记录数, 范围1-50, [default = 20]
- @property (nonatomic, assign) NSInteger offset;
- ///当前页数, 范围1-100, [default = 1]
- @property (nonatomic, assign) NSInteger page;
- ///子区域层级,默认1。规则:设置显示下级行政区级数(行政区级别包括:国家、省/直辖市、市、区/县、乡镇/街道多级数据)可选值:0、1、2、3等数字,0-不返回下级行政区;1-返回下一级行政区;2-返回下两级行政区;3-返回下三级行政区
- @property (nonatomic, assign) NSInteger subdistrict;
- @end
- ///行政区划响应
- @interface AMapDistrictSearchResponse : AMapSearchObject
- ///返回数目
- @property (nonatomic, assign) NSInteger count;
- ///行政区域 AMapDistrict 数组
- @property (nonatomic, strong) NSArray<AMapDistrict *> *districts;
- @end
- #pragma mark - AMapRouteSearchBaseRequest
- ///路径规划基础类,不可直接调用
- @interface AMapRouteSearchBaseRequest : AMapSearchObject
- ///出发点
- @property (nonatomic, copy) AMapGeoPoint *origin;
- ///目的地
- @property (nonatomic, copy) AMapGeoPoint *destination;
- @end
- #pragma mark - AMapDrivingRouteSearchRequest
- ///驾车路径规划
- @interface AMapDrivingRouteSearchRequest : AMapRouteSearchBaseRequest
- /**
- 驾车导航策略,默认策略为0。
- 0,速度优先(时间);1,费用优先(不走收费路段的最快道路);2,距离优先;3,不走快速路;4,躲避拥堵;
- 5,多策略(同时使用速度优先、费用优先、距离优先三个策略计算路径),其中必须说明,就算使用三个策略算路,会根据路况不固定的返回一至三条路径规划信息;
- 6,不走高速;7,不走高速且避免收费;8,躲避收费和拥堵;9,不走高速且躲避收费和拥堵;
- 10,多备选,时间最短,距离最短,躲避拥堵(考虑路况);
- 11,多备选,时间最短,距离最短;
- 12,多备选,躲避拥堵(考虑路况);
- 13,多备选,不走高速;
- 14,多备选,费用优先;
- 15,多备选,躲避拥堵,不走高速(考虑路况);
- 16,多备选,费用有限,不走高速;
- 17,多备选,躲避拥堵,费用优先(考虑路况);
- 18,多备选,躲避拥堵,不走高速,费用优先(考虑路况);
- 19,多备选,高速优先;
- 20,多备选,高速优先,躲避拥堵(考虑路况)
- */
- @property (nonatomic, assign) NSInteger strategy;
- ///途经点 AMapGeoPoint 数组,最多支持16个途经点
- @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
- ///避让区域 AMapGeoPolygon 数组,最多支持100个避让区域,每个区域16个点
- @property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
- ///避让道路名
- @property (nonatomic, copy) NSString *avoidroad;
- ///出发点 POI ID
- @property (nonatomic, copy) NSString *originId;
- ///目的地 POI ID
- @property (nonatomic, copy) NSString *destinationId;
- ///出发点POI类型编码
- @property (nonatomic, copy) NSString *origintype;
- ///目的地POI类型编码
- @property (nonatomic, copy) NSString *destinationtype;
- ///是否返回扩展信息,默认为 NO
- @property (nonatomic, assign) BOOL requireExtension;
- ///车牌省份,用汉字填入车牌省份缩写。用于判断是否限行
- @property (nonatomic, copy) NSString *plateProvince;
- ///车牌详情,填入除省份及标点之外的字母和数字(需大写)。用于判断是否限行。
- @property (nonatomic, copy) NSString *plateNumber;
- ///使用轮渡,0使用1不使用,默认为0使用
- @property (nonatomic, assign) NSInteger ferry;
- /**
- 驾车路径规划车辆类型,默认策略为0。
- 0:普通汽车(默认值);
- 1:纯电动车;
- 2:插电混动车
- */
- @property (nonatomic, assign) NSInteger cartype;
- ///规避道路类型,默认为AMapDrivingRouteExcludeTypeNone,仅海外生效
- @property (nonatomic, assign) AMapDrivingRouteExcludeType exclude;
- @end
- #pragma mark - AMapWalkingRouteSearchRequest
- ///步行路径规划
- @interface AMapWalkingRouteSearchRequest : AMapRouteSearchBaseRequest
- ///是否提供备选步行方案([default = 0])0-只提供一条步行方案; 1-提供备选步行方案(有可能无备选方案)
- @property (nonatomic, assign) NSInteger multipath __attribute__((deprecated("已废弃, from 5.0.0")));
- @end
- #pragma mark - AMapTransitRouteSearchRequest
- ///公交路径规划
- @interface AMapTransitRouteSearchRequest : AMapRouteSearchBaseRequest
- ///公交换乘策略([default = 0])\n 0-最快捷模式;\n 1-最经济模式;\n 2-最少换乘模式;\n 3-最少步行模式;\n 4-最舒适模式;\n 5-不乘地铁模式
- @property (nonatomic, assign) NSInteger strategy;
- ///城市, 必填
- @property (nonatomic, copy) NSString *city;
- ///目的城市, 跨城时需要填写,否则会出错
- @property (nonatomic, copy) NSString *destinationCity;
- ///是否包含夜班车,默认为 NO
- @property (nonatomic, assign) BOOL nightflag;
- ///是否返回扩展信息,默认为 NO
- @property (nonatomic, assign) BOOL requireExtension;
- @end
- #pragma mark - AMapRidingRouteSearchRequest
- ///骑行路径规划
- @interface AMapRidingRouteSearchRequest : AMapRouteSearchBaseRequest
- ///路径方案类型([default = 0])\n 0-推荐路线及最快路线综合\n 1-推荐路线\n 2-最快路线
- @property (nonatomic, assign) NSInteger type __attribute__((deprecated("已废弃, from 5.0.0")));
- ///是否返回扩展信息,默认为 NO (since 7.6.0)
- @property (nonatomic, assign) BOOL requireExtension;
- @end
- ///路径规划返回
- @interface AMapRouteSearchResponse : AMapSearchObject
- ///路径规划信息数目
- @property (nonatomic, assign) NSInteger count;
- ///路径规划信息
- @property (nonatomic, strong) AMapRoute *route;
- @end
- ///骑行路径规划返回
- @interface AMapRidingRouteSearchResponse : AMapRouteSearchResponse
- @end
- #pragma mark - AMapTruckRouteSearchRequest
- ///货车路径规划(since 6.1.0)
- @interface AMapTruckRouteSearchRequest : AMapRouteSearchBaseRequest
- /**
- 驾车导航策略,默认为策略1。
- 1,返回的结果考虑路况,尽量躲避拥堵而规划路径,与高德地图的“躲避拥堵”策略一致;
- 2,返回的结果不走高速,与高德地图“不走高速”策略一致;
- 3,返回的结果尽可能规划收费较低甚至免费的路径,与高德地图“避免收费”策略一致;
- 4,返回的结果考虑路况,尽量躲避拥堵而规划路径,并且不走高速,与高德地图的“躲避拥堵&不走高速”策略一致;
- 5,返回的结果尽量不走高速,并且尽量规划收费较低甚至免费的路径结果,与高德地图的“避免收费&不走高速”策略一致;
- 6,返回路径规划结果会尽量的躲避拥堵,并且规划收费较低甚至免费的路径结果,与高德地图的“躲避拥堵&避免收费”策略一致;
- 7,返回的结果尽量躲避拥堵,规划收费较低甚至免费的路径结果,并且尽量不走高速路,与高德地图的“避免拥堵&避免收费&不走高速”策略一致;
- 8,返回的结果会优先选择高速路,与高德地图的“高速优先”策略一致;
- 9,返回的结果会优先考虑高速路,并且会考虑路况躲避拥堵,与高德地图的“躲避拥堵&高速优先”策略一致。
- */
- @property (nonatomic, assign) NSInteger strategy;
- ///途经点 AMapGeoPoint 数组,最多支持16个途经点
- @property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
- ///出发点 POI ID
- @property (nonatomic, copy) NSString *originId;
- ///目的地 POI ID
- @property (nonatomic, copy) NSString *destinationId;
- ///出发点POI类型编码
- @property (nonatomic, copy) NSString *origintype;
- ///目的地POI类型编码
- @property (nonatomic, copy) NSString *destinationtype;
- ///车牌省份,用汉字填入车牌省份缩写。用于判断是否限行
- @property (nonatomic, copy) NSString *plateProvince;
- ///车牌详情,填入除省份及标点之外的字母和数字(需大写)。用于判断是否限行。
- @property (nonatomic, copy) NSString *plateNumber;
- ///货车大小,默认为 轻型车(AMapTruckSizeTypeLight)
- @property (nonatomic, assign) AMapTruckSizeType size;
- ///车辆高度,单位米,取值[0 – 25.5]米,默认 1.6 米
- @property (nonatomic, assign) CGFloat height;
- ///车辆宽度,单位米,取值[0 – 25.5]米,默认 2.5 米
- @property (nonatomic, assign) CGFloat width;
- ///车辆总重,单位吨,取值[0 – 6553.5]吨,默认 0.9 吨
- @property (nonatomic, assign) CGFloat load;
- ///货车核定载重,单位吨,取值[0 – 6553.5]吨,默认 10 吨
- @property (nonatomic, assign) CGFloat weight;
- ///车辆轴数,单位个,取值[0 –255]个,默认 2个轴
- @property (nonatomic, assign) NSInteger axis;
- ///是否返回扩展信息,默认为 NO (since 7.6.0)
- @property (nonatomic, assign) BOOL requireExtension;
- @end
- #pragma mark - AMapDistanceSearchRequest
- ///距离查询请求(since 6.1.0)
- @interface AMapDistanceSearchRequest : AMapSearchObject
- ///起点坐标数组,最多支持100个点。
- @property (nonatomic, strong) NSArray<AMapGeoPoint *> *origins;
- ///终点坐标
- @property (nonatomic, strong) AMapGeoPoint *destination;
- ///路径计算的方式和方法.0:直线距离; 1:驾车导航距离(仅支持国内坐标)此时会考虑路况,故在不同时间请求返回结果可能不同,此策略和driving接口的 strategy=4策略一致; 默认为1
- @property (nonatomic, assign) NSInteger type;
- ///是否返回扩展信息,默认为 NO (since 7.6.0)
- @property (nonatomic, assign) BOOL requireExtension;
- @end
- ///距离查询结果(since 6.1.0)
- @interface AMapDistanceSearchResponse : AMapSearchObject
- ///距离查询结果 AMapDistanceResult 数组。
- @property (nonatomic, strong) NSArray<AMapDistanceResult *> *results;
- @end
- #pragma mark - AMapWeatherSearchRequest
- ///天气查询请求
- @interface AMapWeatherSearchRequest : AMapSearchObject
- ///城市名称,支持cityname及adcode
- @property (nonatomic, copy) NSString *city;
- ///气象类型,Live为实时天气,Forecast为后三天预报天气,默认为Live
- @property (nonatomic, assign) AMapWeatherType type;
- @end
- ///天气查询返回
- @interface AMapWeatherSearchResponse : AMapSearchObject
- ///实时天气数据信息 AMapLocalWeatherLive 数组,仅在请求实时天气时有返回。
- @property (nonatomic, strong) NSArray<AMapLocalWeatherLive *> *lives;
- ///预报天气数据信息 AMapLocalWeatherForecast 数组,仅在请求预报天气时有返回
- @property (nonatomic, strong) NSArray<AMapLocalWeatherForecast *> *forecasts;
- @end
- #pragma mark - AMapRoadTrafficSearchRequest
- @interface AMapRoadTrafficSearchBaseRequest : AMapSearchObject
- ///道路等级,1:高速(京藏高速)2:城市快速路、国道(西三环、103国道) 3:高速辅路(G6辅路)4:主要道路(长安街、三环辅路路)5:一般道路(彩和坊路)6:无名道路。默认为5. since 5.5.0
- @property (nonatomic, assign) NSInteger level;
- ///是否返回扩展信息,默认为 NO
- @property (nonatomic, assign) BOOL requireExtension;
- @end
- ///道路实时路况查询请求 since 5.1.0
- @interface AMapRoadTrafficSearchRequest : AMapRoadTrafficSearchBaseRequest
- ///道路名称,可通过逆地理编码查询获取
- @property (nonatomic, copy) NSString *roadName;
- ///城市adcode,可参考 http://a.amap.com/lbs/static/zip/AMap_adcode_citycode.zip
- @property (nonatomic, copy) NSString *adcode;
- @end
- ///圆形区域道路实时路况查询请求 since 5.5.0 注意:返回路况结果取决于发起请求时刻的实时路况,不保证范围内的所有路线路况都会返回,也不保证返回的路况长度一定在限制半径内
- @interface AMapRoadTrafficCircleSearchRequest : AMapRoadTrafficSearchBaseRequest
- ///必填,中心点坐标。
- @property (nonatomic, copy) AMapGeoPoint *location;
- ///查询半径,单位:米。[0, 5000], 默认值为1000.
- @property (nonatomic, assign) NSInteger radius;
- @end
- ///道路实时路况查询返回 since 5.1.0
- @interface AMapRoadTrafficSearchResponse : AMapSearchObject
- ///路况信息
- @property (nonatomic, strong) AMapTrafficInfo *trafficInfo;
- @end
- #pragma mark - AMapNearbySearchRequest
- ///附近搜索请求
- @interface AMapNearbySearchRequest : AMapSearchObject
- ///中心点坐标
- @property (nonatomic, copy) AMapGeoPoint *center;
- ///查询半径,范围:[0, 10000],单位:米 [default = 1000]
- @property (nonatomic, assign) NSInteger radius;
- ///搜索距离类型,默认为直线距离
- @property (nonatomic, assign) AMapNearbySearchType searchType;
- ///检索时间范围,超过24小时的数据无法返回,范围[5, 24*60*60] 单位:秒 [default = 1800]
- @property (nonatomic, assign) NSInteger timeRange;
- ///返回条数,范围[1, 100], 默认30
- @property (nonatomic, assign) NSInteger limit;
- @end
- ///附近搜索返回
- @interface AMapNearbySearchResponse : AMapSearchObject
- ///结果总条数
- @property (nonatomic, assign) NSInteger count;
- ///周边用户信息 AMapNearbyUserInfo 数组
- @property (nonatomic, strong) NSArray<AMapNearbyUserInfo *> *infos;
- @end
- #pragma mark - AMapCloudSearchBaseRequest
- ///企业地图搜索请求基类
- @interface AMapCloudSearchBaseRequest : AMapSearchObject
- ///要查询的表格ID, 必选
- @property (nonatomic, copy) NSString *tableID;
- ///筛选条件数组, 可选, 说明:\n 1.支持建立索引的字段根据多个条件筛选,多个条件用双&符号连接;\n 2.判断符合支持:>= 大于等于,<= 小于等于,>大于,<小于,= 精确匹配(text索引不可用);\n 3.示例规则:key1=value1&&key2=value2&&lastloctime>=1469817532,示例:"name=王师傅|张师傅&&lastloctime>=1469817532
- @property (nonatomic, strong) NSArray<NSString *> *filter;
- ///排序字段名, 可选.\n 说明:\n 1.支持按建立了排序筛选索引的整数或小数字段进行排序:sortFields = "字段名";\n 2.系统预设的字段(忽略sortType):_distance:坐标与中心点距离升序排序,仅在周边检索时有效(若其它请求使用会异常返回);_weight:权重降序排序,当存在keywords时有效;\n;
- @property (nonatomic, copy) NSString *sortFields;
- ///可选, 排序方式(默认升序)
- @property (nonatomic, assign) AMapCloudSortType sortType;
- ///可选, 每页记录数(每页最大记录数100, 默认20)
- @property (nonatomic, assign) NSInteger offset;
- ///可选, 当前页数(>=1, 默认1)
- @property (nonatomic, assign) NSInteger page;
- @end
- #pragma mark - AMapCloudPlaceAroundSearchRequest
- ///企业地图周边搜请求
- @interface AMapCloudPOIAroundSearchRequest : AMapCloudSearchBaseRequest
- ///必填,中心点坐标。
- @property (nonatomic, copy) AMapGeoPoint *center;
- ///可选,查询半径(默认值为3000),单位:米
- @property (nonatomic, assign) NSInteger radius;
- ///可选,搜索关键词。\n 说明:1. 只支持建立过文本索引的字段查询/n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。/n 3.支持关键字多值模糊检索;如keywords=招商银行&&华夏银行&&工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集
- @property (nonatomic, copy) NSString *keywords;
- @end
- ///企业地图polygon区域查询请求
- @interface AMapCloudPOIPolygonSearchRequest : AMapCloudSearchBaseRequest
- ///必填,多边形。
- @property (nonatomic, copy) AMapGeoPolygon *polygon;
- ///可选,搜索关键词。\n 说明:1. 只支持建立过文本索引的字段查询/n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。/n 3.支持关键字多值模糊检索;如keywords=招商银行&&华夏银行&&工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集
- @property (nonatomic, copy) NSString *keywords;
- @end
- ///企业地图ID查询请求
- @interface AMapCloudPOIIDSearchRequest : AMapCloudSearchBaseRequest
- ///必填,POI的ID
- @property (nonatomic, assign) NSInteger uid;
- @end
- ///企业地图本地查询请求
- @interface AMapCloudPOILocalSearchRequest : AMapCloudSearchBaseRequest
- ///可选,搜索关键词。\n 说明:1. 只支持建立过文本索引的字段查询/n 2.支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。/n 3.支持关键字多值模糊检索;如keywords=招商银行&&华夏银行&&工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集
- @property (nonatomic, copy) NSString *keywords;
- ///必填,城市名称\n 说明:\n 1. 支持全国/省/市/区县行政区划范围的检索;\n 2. city = "全国",即对用户全表搜索;\n 3. 当city值设置非法或不正确时,按照 city = "全国"返回。
- @property (nonatomic, copy) NSString *city;
- @end
- ///企业地图搜索返回
- @interface AMapCloudPOISearchResponse : AMapSearchObject
- ///返回结果总数目
- @property (nonatomic, assign) NSInteger count;
- ///返回的结果, AMapCloudPOI 数组
- @property (nonatomic, strong) NSArray<AMapCloudPOI *> *POIs;
- @end
- #pragma mark - AMapShareSearchBaseRequest
- ///短串分享搜索请求基类, 请使用具体的子类。
- @interface AMapShareSearchBaseRequest : AMapSearchObject
- @end
- ///位置短串分享请求
- @interface AMapLocationShareSearchRequest : AMapShareSearchBaseRequest
- ///必填, 位置坐标
- @property (nonatomic, copy) AMapGeoPoint *location;
- ///位置名称,请不要包含【,%&@#】等特殊符号
- @property (nonatomic, copy) NSString *name;
- @end
- ///兴趣点短串分享请求
- @interface AMapPOIShareSearchRequest : AMapShareSearchBaseRequest
- ///POI的ID,如果有ID则指定POI,否则按name查询。
- @property (nonatomic, copy) NSString *uid;
- ///坐标
- @property (nonatomic, copy) AMapGeoPoint *location;
- ///名称,请不要包含【,%&@#】等特殊符号。
- @property (nonatomic, copy) NSString *name;
- ///地址,请不要包含【,%&@#】等特殊符号。
- @property (nonatomic, copy) NSString *address;
- @end
- ///路径规划短串分享请求
- @interface AMapRouteShareSearchRequest : AMapShareSearchBaseRequest
- ///默认为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 步行,无策略,均一样
- @property (nonatomic, assign) NSInteger strategy;
- ///Route的type,默认为0,超出范围为0.\n 0为驾车,\n 1为公交,\n 2为步行
- @property (nonatomic, assign) NSInteger type;
- ///起点坐标
- @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
- ///终点坐标
- @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
- ///起点名称,默认为“已选择的位置”,请不要包含【,%&@#】等特殊符号
- @property (nonatomic, copy) NSString *startName;
- ///终点名称,默认为“已选择的位置”,请不要包含【,%&@#】等特殊符号
- @property (nonatomic, copy) NSString *destinationName;
- @end
- ///导航短串分享请求
- @interface AMapNavigationShareSearchRequest : AMapShareSearchBaseRequest
- ///默认为0,超出范围为0\n 驾车:0-速度最快(时间);\n 1-避免收费(不走收费路段的最快道路);\n 2-距离优先;\n 3-不走高速;\n 4-结合实时交通(躲避拥堵);\n 5-不走高速且避免收费;\n 6-不走高速且躲避拥堵;\n 7-躲避收费和拥堵;\n 8-不走高速且躲避收费和拥堵
- @property (nonatomic, assign) NSInteger strategy;
- ///起点坐标,若跳转到高德地图,默认更换为定位坐标
- @property (nonatomic, copy) AMapGeoPoint *startCoordinate;
- ///终点坐标
- @property (nonatomic, copy) AMapGeoPoint *destinationCoordinate;
- @end
- ///导航短串分享响应
- @interface AMapShareSearchResponse : AMapSearchObject
- ///转换后的短串
- @property (nonatomic, copy) NSString *shareURL;
- @end
- ///未来路线规划(since 6.9.0)
- @interface AMapFutureRouteSearchRequest : AMapRouteSearchBaseRequest
- ///出发时间 单位为秒
- @property (nonatomic, copy) NSString *beginTime;
- ///时间间隔 单位为秒
- @property (nonatomic, assign) NSInteger interval;
- ///时间点个数,最多48个
- @property (nonatomic, assign) NSInteger timeCount;
- /**
- 未来路线规划策略,默认策略为0。
- 1,返回的结果考虑路况,尽量躲避拥堵而规划路径,与高德地图的“躲避拥堵”策略一致
- 2,返回的结果不走高速,与高德地图“不走高速”策略一致
- 3,返回的结果尽可能规划收费较低甚至免费的路径,与高德地图“避免收费”策略一致
- 4,返回的结果考虑路况,尽量躲避拥堵而规划路径,并且不走高速,与高德地图的“躲避拥堵&不走高速”策略一致
- 5,返回的结果尽量不走高速,并且尽量规划收费较低甚至免费的路径结果,与高德地图的“避免收费&不走高速”策略一致
- 6,返回路径规划结果会尽量的躲避拥堵,并且规划收费较低甚至免费的路径结果,与高德地图的“躲避拥堵&避免收费”策略一致
- 7,返回的结果尽量躲避拥堵,规划收费较低甚至免费的路径结果,并且尽量不走高速路,与高德地图的“避免拥堵&避免收费&不走高速”策略一致
- 8,返回的结果会优先选择高速路,与高德地图的“高速优先”策略一致
- 9,返回的结果会优先考虑高速路,并且会考虑路况躲避拥堵,与高德地图的“躲避拥堵&高速优先”策略一致
- 10,不考虑路况,返回速度最优、耗时最短的路线,但是此路线不一定距离最短
- 11,避让拥堵&速度优先&避免收费
- */
- @property (nonatomic, assign) NSInteger strategy;
- ///出发点 POI ID
- @property (nonatomic, copy) NSString *originId;
- ///目的地 POI ID
- @property (nonatomic, copy) NSString *destinationId;
- ///出发点POI类型编码
- @property (nonatomic, copy) NSString *origintype;
- ///目的地POI类型编码
- @property (nonatomic, copy) NSString *destinationtype;
- ///终点的父POI ID
- @property (nonatomic, copy) NSString *parentId;
- /////是否返回扩展信息,默认为 NO
- //@property (nonatomic, assign) BOOL requireExtension;
- ///车牌省份,用汉字填入车牌省份缩写。用于判断是否限行
- @property (nonatomic, copy) NSString *plateProvince;
- ///车牌详情,填入除省份及标点之外的字母和数字(需大写)。用于判断是否限行。
- @property (nonatomic, copy) NSString *plateNumber;
- /**
- 驾车路径规划车辆类型,默认策略为0。
- 0:普通汽车(默认值);
- 1:纯电动车;
- 2:插电混动车
- */
- @property (nonatomic, assign) NSInteger cartype;
- @end
- ///未来路线规划(since 6.9.0)
- @interface AMapFutureRouteSearchResponse : AMapSearchObject
- ///路径规划方案,只会返回AMapPath中的distance、totalTrafficLights、steps
- @property (nonatomic, strong) NSArray<AMapPath *> *paths;
- ///不同时间的规划以及信息列表
- @property (nonatomic, strong) NSArray<AMapFutureTimeInfo *> *timeInfos;
- @end
|