AMapSearchObj.h

Go to the documentation of this file.

//
//  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,   
    AMapRoutePOISearchTypeToilet             = 3,   
    AMapRoutePOISearchTypeGasAirStation      = 4,   
    AMapRoutePOISearchTypeParkStation        = 5,   
    AMapRoutePOISearchTypeChargingPile       = 6,   
    AMapRoutePOISearchTypeFood               = 7,   
    AMapRoutePOISearchTypeHotel              = 8,   
};
 
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, 
};
 
typedef NS_OPTIONS(NSUInteger, AMapDrivingRouteShowFieldType)
{
    AMapDrivingRouteShowFieldTypeNone     = 1 << 0, 
    AMapDrivingRouteShowFieldTypeCost     = 1 << 1, 
    AMapDrivingRouteShowFieldTypeTmcs     = 1 << 2, 
    AMapDrivingRouteShowFieldTypeNavi     = 1 << 3, 
    AMapDrivingRouteShowFieldTypeCities   = 1 << 4, 
    AMapDrivingRouteShowFieldTypePolyline = 1 << 5, 
    AMapDrivingRouteShowFieldTypeNewEnergy = 1 << 6,
    AMapDrivingRouteShowFieldTypeAll      = ~0UL,   
};
 
typedef NS_OPTIONS(NSUInteger, AMapWalkingRouteShowFieldType)
{
    AMapWalkingRouteShowFieldTypeNone     = 0 << 0, 
    AMapWalkingRouteShowFieldTypeCost     = 1 << 0, 
    AMapWalkingRouteShowFieldTypeNavi     = 1 << 1, 
    AMapWalkingRouteShowFieldTypePolyline = 1 << 2, 
    AMapWalkingRouteShowFieldTypeAll      = ~0UL,   
};
 
typedef NS_OPTIONS(NSUInteger, AMapTransitRouteShowFieldsType)
{
    AMapTransitRouteShowFieldsTypeNone     = 1 << 0, 
    AMapTransitRouteShowFieldsTypeCost     = 1 << 1, 
    AMapTransitRouteShowFieldsTypeNavi     = 1 << 2, 
    AMapTransitRouteShowFieldsTypePolyline = 1 << 3, 
    AMapTransitRouteShowFieldsTypeAll      = ~0UL,   
};
 
typedef NS_OPTIONS(NSUInteger, AMapRidingRouteShowFieldsType)
{
    AMapRidingRouteShowFieldsTypeNone     = 1 << 0, 
    AMapRidingRouteShowFieldsTypeCost     = 1 << 1, 
    AMapRidingRouteShowFieldsTypeNavi     = 1 << 2, 
    AMapRidingRouteShowFieldsTypePolyline = 1 << 3, 
    AMapRidingRouteShowFieldsTypeAll      = ~0UL,   
};
 
typedef NS_OPTIONS(NSUInteger, AMapPOISearchShowFieldsType)
{
    AMapPOISearchShowFieldsTypeNone          = 1 << 0, 
    AMapPOISearchShowFieldsTypeChildren      = 1 << 1, 
    AMapPOISearchShowFieldsTypeBusiness      = 1 << 2, 
    AMapPOISearchShowFieldsTypeIndoor        = 1 << 3, 
    AMapPOISearchShowFieldsTypeNavi          = 1 << 4, 
    AMapPOISearchShowFieldsTypePhotos        = 1 << 5, 
    AMapPOISearchShowFieldsTypeAll           = ~0UL,   
};
 
typedef NS_ENUM(NSInteger, AMapDistanceSearchType)
{
    AMapDistanceSearchTypeStraight        = 0, 
    AMapDistanceSearchTypeDrive           = 1, 
    AMapDistanceSearchTypeWalk            = 3, 
};
 
#pragma mark - AMapPOISearchBaseRequest
 
@interface AMapPOISearchBaseRequest : AMapSearchObject
@property (nonatomic, copy)   NSString  *types;
@property (nonatomic, assign) NSInteger  sortrule;
@property (nonatomic, assign) NSInteger  offset;
@property (nonatomic, assign) NSInteger  page;
@property (nonatomic, assign) AMapPOISearchShowFieldsType  showFieldsType;
@end
 
@interface AMapPOIIDSearchRequest : AMapPOISearchBaseRequest
@property (nonatomic, copy) NSString *uid; 
@end
 
#pragma mark - AMapVisualSearchRequest
 
@interface AMapVisualSearchRequest : AMapSearchObject
@property (nonatomic, copy) NSString *pic;
@property (nonatomic, copy) AMapGeoPoint *location;
@property (nonatomic, assign) CGFloat angle;
@property (nonatomic, copy) NSString *adiu;
@property (nonatomic, copy) NSString *apiKey;
 
@end
 
@interface AMapPOIKeywordsSearchRequest : AMapPOISearchBaseRequest
@property (nonatomic, copy)   NSString *keywords; 
@property (nonatomic, copy)   NSString *city;
@property (nonatomic, assign) BOOL cityLimit;
@property (nonatomic, strong) AMapGeoPoint *location;
 
@end
 
@interface AMapPOIAroundSearchRequest : AMapPOISearchBaseRequest
@property (nonatomic, copy)   NSString     *keywords; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, assign) NSInteger     radius;
@property (nonatomic, copy)   NSString     *city;
@end
 
@interface AMapPOIPolygonSearchRequest : AMapPOISearchBaseRequest
@property (nonatomic, copy) NSString       *keywords; 
@property (nonatomic, copy) AMapGeoPolygon *polygon; 
@end
 
@interface AMapPOISearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger       count; 
@property (nonatomic, strong) AMapSuggestion *suggestion; 
@property (nonatomic, strong) NSArray<AMapPOI *> *pois;
@end
 
@interface AMapVisualPOI : AMapPOI
@property (nonatomic, copy)   NSString     *bizType;
@property (nonatomic, copy)   NSString     *alias;
@property (nonatomic, copy)   NSString     *tag;
@property (nonatomic, strong) NSArray<AMapTopListItem *> *topList;
@property (nonatomic, copy)   NSString     *featuredReviews;
@end
 
@interface AMapVisualSearchResponse : AMapSearchObject
@property (nonatomic, copy) NSString *category;
@property (nonatomic, strong) NSArray<AMapVisualPOI *> *pois;
@end
 
#pragma mark - AMapPOIRouteSearchRequest
@interface AMapRoutePOISearchRequest : AMapSearchObject
@property (nonatomic, copy)   AMapGeoPoint *origin; 
@property (nonatomic, copy)   AMapGeoPoint *destination; 
@property (nonatomic, assign) AMapRoutePOISearchType searchType; 
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, assign) NSInteger range;
@property (nonatomic, strong) NSString *polylineStr;
@property (nonatomic, strong) NSArray<AMapGeoPoint*> *polyline;
 
@end
 
@interface AMapRoutePOISearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger count; 
@property (nonatomic, strong) NSArray<AMapRoutePOI *> *pois; 
@end
 
#pragma mark - AMapInputTipsSearchRequest
 
@interface AMapInputTipsSearchRequest : AMapSearchObject
@property (nonatomic, copy)   NSString *keywords; 
@property (nonatomic, copy)   NSString *city; 
@property (nonatomic, copy)   NSString *types; 
@property (nonatomic, assign) BOOL cityLimit;
@property (nonatomic, copy) NSString *location;
@end
 
@interface AMapInputTipsSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger  count; 
@property (nonatomic, strong) NSArray<AMapTip *> *tips; 
@end
 
#pragma mark - AMapGeocodeSearchRequest
 
@interface AMapGeocodeSearchRequest : AMapSearchObject
@property (nonatomic, copy) NSString *address;
@property (nonatomic, copy) NSString *city;
@property (nonatomic, copy) NSString *country;
@end
 
@interface AMapGeocodeSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger  count; 
@property (nonatomic, strong) NSArray<AMapGeocode *> *geocodes; 
@end
 
 
#pragma mark - AMapReGeocodeSearchRequest
 
@interface AMapReGeocodeSearchRequest : AMapSearchObject
@property (nonatomic, assign) BOOL          requireExtension; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, assign) NSInteger     radius;
@property (nonatomic, copy) NSString *poitype;
@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; 
@property (nonatomic, copy)   NSString  *city; 
@property (nonatomic, assign) NSInteger  offset; 
@property (nonatomic, assign) NSInteger  page; 
@end
 
@interface AMapBusStopSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger       count; 
@property (nonatomic, strong) AMapSuggestion *suggestion; 
@property (nonatomic, strong) NSArray<AMapBusStop *> *busstops; 
@end
 
#pragma mark - AMapBusLineSearchRequest
 
@interface AMapBusLineBaseSearchRequest : AMapSearchObject
@property (nonatomic, copy)   NSString  *city; 
@property (nonatomic, assign) BOOL       requireExtension; 
@property (nonatomic, assign) NSInteger  offset; 
@property (nonatomic, assign) NSInteger  page; 
@end
 
@interface AMapBusLineNameSearchRequest : AMapBusLineBaseSearchRequest
@property (nonatomic, copy) NSString *keywords; 
@end
 
@interface AMapBusLineIDSearchRequest : AMapBusLineBaseSearchRequest
@property (nonatomic, copy) NSString *uid;
@end
 
@interface AMapBusLineSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger       count; 
@property (nonatomic, strong) AMapSuggestion *suggestion; 
@property (nonatomic, strong) NSArray<AMapBusLine *> *buslines; 
@end
 
#pragma mark - AMapDistrictSearchRequest
@interface AMapDistrictSearchRequest : AMapSearchObject
@property (nonatomic, copy)   NSString *keywords;
@property (nonatomic, assign) BOOL      requireExtension; 
@property (nonatomic, assign) BOOL      showBusinessArea __attribute__((deprecated("已废弃, from 5.3.0")));;
@property (nonatomic, assign) NSInteger  offset;
@property (nonatomic, assign) NSInteger  page;
@property (nonatomic, assign) NSInteger subdistrict;
 
@end
 
@interface AMapDistrictSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger  count; 
@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 - AMapDrivingCalRouteSearchRequest
 
@interface AMapDrivingCalRouteSearchRequest : AMapRouteSearchBaseRequest
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
@property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
@property (nonatomic, copy) NSString *avoidroad;
@property (nonatomic, copy) NSString *originId;
@property (nonatomic, copy) NSString *destinationId;
@property (nonatomic, copy) NSString *origintype;
@property (nonatomic, copy) NSString *destinationtype;
@property (nonatomic, copy) NSString *plate;
@property (nonatomic, assign) NSInteger ferry;
@property (nonatomic, assign) NSInteger cartype;
@property (nonatomic, assign) AMapDrivingRouteShowFieldType showFieldType;
 
@end
 
#pragma mark - AMapDrivingRouteSearchRequest
 
@interface AMapDrivingRouteSearchRequest : AMapRouteSearchBaseRequest
 
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
@property (nonatomic, copy) NSArray<AMapGeoPolygon *> *avoidpolygons;
@property (nonatomic, copy) NSString *avoidroad;
@property (nonatomic, copy) NSString *originId;
@property (nonatomic, copy) NSString *destinationId;
@property (nonatomic, copy) NSString *origintype;
@property (nonatomic, copy) NSString *destinationtype;
@property (nonatomic, assign) BOOL requireExtension;
@property (nonatomic, copy) NSString *plateProvince;
@property (nonatomic, copy) NSString *plateNumber;
@property (nonatomic, assign) NSInteger ferry;
@property (nonatomic, assign) NSInteger cartype;
@property (nonatomic, assign) AMapDrivingRouteExcludeType exclude;
 
@end
 
#pragma mark - AMapWalkingRouteSearchRequest
 
@interface AMapWalkingRouteSearchRequest : AMapRouteSearchBaseRequest
@property (nonatomic, assign) NSInteger multipath __attribute__((deprecated("已废弃, from 5.0.0")));
 
@property (nonatomic, assign) NSInteger isindoor;
@property (nonatomic, assign) NSInteger alternativeRoute;
@property (nonatomic, assign) AMapWalkingRouteShowFieldType showFieldsType;
@end
 
#pragma mark - AMapTransitRouteSearchRequest
 
@interface AMapTransitRouteSearchRequest : AMapRouteSearchBaseRequest
/*
0：推荐模式，综合权重，同高德APP默认
1：最经济模式，票价最低
2：最少换乘模式，换乘次数少
3：最少步行模式，尽可能减少步行距离
4：最舒适模式，尽可能乘坐空调车
5：不乘地铁模式，不乘坐地铁路线
6：地铁图模式，起终点都是地铁站（地铁图模式下originpoi及destinationpoi为必填项）
7：地铁优先模式，步行距离不超过4KM
8：时间短模式，方案花费总时间最少
 */
@property (nonatomic, assign) NSInteger strategy; 
@property (nonatomic, copy)   NSString *city;
@property (nonatomic, copy)   NSString *destinationCity; 
@property (nonatomic, assign) BOOL nightflag;
@property (nonatomic, copy)   NSString *originPOI;
@property (nonatomic, copy)   NSString *destinationPOI;
@property (nonatomic, copy)   NSString *adcode;
@property (nonatomic, copy)   NSString *destinationAdcode;
@property (nonatomic, assign) NSInteger alternativeRoute;
@property (nonatomic, assign) BOOL multiExport;
@property (nonatomic, assign) NSInteger maxTrans;
@property (nonatomic, copy)   NSString *date;
@property (nonatomic, copy)   NSString *time;
@property (nonatomic, assign) AMapTransitRouteShowFieldsType showFieldsType;
@end
 
#pragma mark - AMapRidingRouteSearchRequest
 
@interface AMapRidingRouteSearchRequest : AMapRouteSearchBaseRequest
@property (nonatomic, assign) NSInteger alternativeRoute;
@property (nonatomic, assign) AMapRidingRouteShowFieldsType showFieldsType;
@end
 
@interface AMapRouteSearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger count; 
@property (nonatomic, strong) AMapRoute *route; 
@end
 
@interface AMapRidingRouteSearchResponse : AMapRouteSearchResponse
@end
 
#pragma mark - AMapTruckRouteSearchRequest
 
@interface AMapTruckRouteSearchRequest : AMapRouteSearchBaseRequest
 
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, copy) NSArray<AMapGeoPoint *> *waypoints;
@property (nonatomic, copy) NSString *originId;
@property (nonatomic, copy) NSString *destinationId;
@property (nonatomic, copy) NSString *origintype;
@property (nonatomic, copy) NSString *destinationtype;
@property (nonatomic, copy) NSString *plateProvince;
@property (nonatomic, copy) NSString *plateNumber;
@property (nonatomic, assign) AMapTruckSizeType size;
@property (nonatomic, assign) CGFloat height;
@property (nonatomic, assign) CGFloat width;
@property (nonatomic, assign) CGFloat load;
@property (nonatomic, assign) CGFloat weight;
@property (nonatomic, assign) NSInteger axis;
@property (nonatomic, assign) BOOL requireExtension;
@end
 
#pragma mark - AMapDistanceSearchRequest
 
@interface AMapDistanceSearchRequest : AMapSearchObject
@property (nonatomic, strong) NSArray<AMapGeoPoint *> *origins;
@property (nonatomic, strong) AMapGeoPoint *destination;
@property (nonatomic, assign) AMapDistanceSearchType type;
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, assign) BOOL requireExtension;
@end
 
@interface AMapDistanceSearchResponse : AMapSearchObject
@property (nonatomic, strong) NSArray<AMapDistanceResult *> *results;
 
@end
 
#pragma mark - AMapWeatherSearchRequest
 
@interface AMapWeatherSearchRequest : AMapSearchObject
@property (nonatomic, copy)   NSString        *city; 
@property (nonatomic, assign) AMapWeatherType  type; 
@end
 
@interface AMapWeatherSearchResponse : AMapSearchObject
@property (nonatomic, strong) NSArray<AMapLocalWeatherLive *> *lives; 
@property (nonatomic, strong) NSArray<AMapLocalWeatherForecast *> *forecasts; 
 
@end
 
#pragma mark - AMapNearbySearchRequest
@interface AMapNearbySearchRequest : AMapSearchObject
@property (nonatomic, copy)   AMapGeoPoint *center; 
@property (nonatomic, assign) NSInteger radius; 
@property (nonatomic, assign) AMapNearbySearchType searchType; 
@property (nonatomic, assign) NSInteger timeRange; 
@property (nonatomic, assign) NSInteger limit; 
@end
 
@interface AMapNearbySearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger count; 
@property (nonatomic, strong) NSArray<AMapNearbyUserInfo *> *infos; 
@end
 
#pragma mark - AMapCloudSearchBaseRequest
 
@interface AMapCloudSearchBaseRequest : AMapSearchObject
@property (nonatomic, copy) NSString *tableID;
@property (nonatomic, strong) NSArray<NSString *> *filter;
@property (nonatomic, copy) NSString *sortFields;
@property (nonatomic, assign) AMapCloudSortType sortType;
@property (nonatomic, assign) NSInteger offset;
@property (nonatomic, assign) NSInteger page;
@end
 
#pragma mark - AMapCloudPlaceAroundSearchRequest
 
@interface AMapCloudPOIAroundSearchRequest : AMapCloudSearchBaseRequest
@property (nonatomic, copy)   AMapGeoPoint *center;
@property (nonatomic, assign) NSInteger     radius;
@property (nonatomic, copy) NSString *keywords;
@end
 
@interface AMapCloudPOIPolygonSearchRequest : AMapCloudSearchBaseRequest
@property (nonatomic, copy) AMapGeoPolygon *polygon;
@property (nonatomic, copy) NSString *keywords;
@end
 
@interface AMapCloudPOIIDSearchRequest : AMapCloudSearchBaseRequest
@property (nonatomic, assign) NSInteger uid; 
@end
 
@interface AMapCloudPOILocalSearchRequest : AMapCloudSearchBaseRequest
@property (nonatomic, copy) NSString *keywords;
@property (nonatomic, copy) NSString *city; 
@end
 
@interface AMapCloudPOISearchResponse : AMapSearchObject
@property (nonatomic, assign) NSInteger  count; 
@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
@property (nonatomic, copy) NSString     *uid; 
@property (nonatomic, copy) AMapGeoPoint *location; 
@property (nonatomic, copy) NSString     *name; 
@property (nonatomic, copy) NSString     *address; 
@end
 
@interface AMapRouteShareSearchRequest : AMapShareSearchBaseRequest
@property (nonatomic, assign) NSInteger     strategy; 
@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
 
@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
 
@interface AMapFutureRouteSearchRequest : AMapRouteSearchBaseRequest
@property (nonatomic, copy) NSString *beginTime;
@property (nonatomic, assign) NSInteger interval;
@property (nonatomic, assign) NSInteger timeCount;
@property (nonatomic, assign) NSInteger strategy;
@property (nonatomic, copy) NSString *originId;
@property (nonatomic, copy) NSString *destinationId;
@property (nonatomic, copy) NSString *origintype;
@property (nonatomic, copy) NSString *destinationtype;
@property (nonatomic, copy) NSString *parentId;
 
//@property (nonatomic, assign) BOOL requireExtension;
@property (nonatomic, copy) NSString *plateProvince;
@property (nonatomic, copy) NSString *plateNumber;
@property (nonatomic, assign) NSInteger cartype;
@end
 
@interface AMapFutureRouteSearchResponse : AMapSearchObject
@property (nonatomic, strong) NSArray<AMapPath *> *paths;
@property (nonatomic, strong) NSArray<AMapFutureTimeInfo *> *timeInfos;
@end
 
@interface AMapChargeStationSearchRequest : AMapSearchObject
@end
 
@interface AMapChargeStationSearchResponse : AMapSearchObject
@end