BaiduMap_IOSSDK_v7.1.0_Docs 7.1.0

BMKPoiSearchOption.h
浏览该文件的文档.
1 //
2 // BMKPOISearchOption.h
3 // SearchComponent
4 //
5 // 本文件中包含了5种POI检索对应的请求参数信息类，以及其中用到的参数类、枚举等。
6 // 请求参数信息类的命名规则统一为 BMKPOIXXXSearchOption
7 //
8 // Created by Baidu on 2018/5/8.
9 // Copyright © 2018年 Baidu. All rights reserved.
10 //
11
12 #import <Foundation/Foundation.h>
13 #import "BMKPoiSearchType.h"
14 #import <BaiduMapAPI_Base/BMKTypes.h>
15
16
17 #pragma mark - 枚举类型
18
25 typedef NS_ENUM(NSUInteger, BMKPOIIndustryType) {
26 BMK_POI_INDUSTRY_TYPE_HOTEL = 1,
27 BMK_POI_INDUSTRY_TYPE_CATER,
28 BMK_POI_INDUSTRY_TYPE_LIFE,
29 };
30
53 typedef NS_ENUM(NSUInteger, BMKPOISortBasisType) {
54 BMK_POI_SORT_BASIS_TYPE_HOTEL_DEFAULT = 1,
55 BMK_POI_SORT_BASIS_TYPE_HOTEL_PRICE,
56 BMK_POI_SORT_BASIS_TYPE_HOTEL_DISTANCE,
57 BMK_POI_SORT_BASIS_TYPE_HOTEL_TOTAL_SCORE,
58 BMK_POI_SORT_BASIS_TYPE_HOTEL_LEVEL,
59 BMK_POI_SORT_BASIS_TYPE_HOTEL_HEALTH_SCORE,
60
61 BMK_POI_SORT_BASIS_TYPE_CATER_DEFAULT = 10,
62 BMK_POI_SORT_BASIS_TYPE_CATER_PRICE,
63 BMK_POI_SORT_BASIS_TYPE_CATER_DISTANCE,
64 BMK_POI_SORT_BASIS_TYPE_CATER_TASTE_RATING,
65 BMK_POI_SORT_BASIS_TYPE_CATER_OVERALL_RATING,
66 BMK_POI_SORT_BASIS_TYPE_CATER_SERVICE_RATING,
67
68 BMK_POI_SORT_BASIS_TYPE_LIFE_DEFAULT = 20,
69 BMK_POI_SORT_BASIS_TYPE_LIFE_PRICE,
70 BMK_POI_SORT_BASIS_TYPE_LIFE_DISTANCE,
71 BMK_POI_SORT_BASIS_TYPE_LIFE_OVERALL_RATING,
72 BMK_POI_SORT_BASIS_TYPE_LIFE_COMMENT_NUMBER,
73 };
74
81 typedef NS_ENUM(NSUInteger, BMKPOISortRuleType) {
82 BMK_POI_SORT_RULE_DESCENDING = 0,
83 BMK_POI_SORT_RULE_ASCENDING,
84 };
85
92 typedef NS_ENUM(NSUInteger, BMKPOISearchScopeType) {
93 BMK_POI_SCOPE_BASIC_INFORMATION = 1,
94 BMK_POI_SCOPE_DETAIL_INFORMATION,
95 };
96
97
98 #pragma mark - POI检索过滤条件类
99 @interface BMKPOISearchFilter : NSObject
101 @property (nonatomic, assign) BMKPOIIndustryType industryType;
106 @property (nonatomic, assign) BMKPOISortBasisType sortBasis;
108 @property (nonatomic, assign) BMKPOISortRuleType sortRule;
110 @property (nonatomic, assign) BOOL isGroupon;
112 @property (nonatomic, assign) BOOL isDiscount;
113 @end
114
115
116 #pragma mark - POI城市检索参数信息类
117 @interface BMKPOICitySearchOption : NSObject
120 @property (nonatomic, copy) NSString *keyword;
122 @property (nonatomic, copy) NSString *type;
124 @property (nonatomic, copy) NSArray<NSString *> *tags;
126 @property (nonatomic, copy) NSString *city;
128 @property (nonatomic, assign) BOOL isCityLimit;
130 @property (nonatomic, assign) BMKPOISearchScopeType scope;
132 @property (nonatomic, strong) BMKPOISearchFilter *filter;
135 @property (nonatomic, assign) BOOL addressResult;
137 @property (nonatomic, assign) BOOL homonym;
139 @property (nonatomic, assign) BOOL isLightVersion;
141 @property (nonatomic, assign) CLLocationCoordinate2D location;
142
145 @property (nonatomic, assign) NSInteger filterDistance;
147 @property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
149 @property (nonatomic, assign) CLLocationCoordinate2D rightTop;
151 @property (nonatomic, assign) BOOL isBoundLimit;
152
155 @property (nonatomic, assign) BOOL showPhotos;
157 @property (nonatomic, assign) NSInteger pageIndex;
159 @property (nonatomic, assign) NSInteger pageSize;
161 @property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
163 @property (nonatomic, assign) BMKLanguageType languageType;
165 @property (nonatomic, assign) BMKSearchServiceRegionType serverType;
167 @property (nonatomic, assign) BOOL extensionsAdcode;
169 @property (nonatomic, assign) BOOL extensionsChildPoi;
170 @end
171
172
173 #pragma mark - POI周边检索参数信息类
174 @interface BMKPOINearbySearchOption : NSObject
181 @property (nonatomic, copy) NSArray<NSString *> *keywords;
183 @property (nonatomic, copy) NSString *type;
189 @property (nonatomic, copy) NSArray<NSString *> *tags;
191 @property (nonatomic, assign) CLLocationCoordinate2D location;
196 @property (nonatomic, assign) NSInteger radius;
202 @property (nonatomic, assign) BOOL isRadiusLimit;
204 @property (nonatomic, assign) BMKPOISearchScopeType scope;
206 @property (nonatomic, strong) BMKPOISearchFilter *filter;
209 @property (nonatomic, assign) BOOL addressResult;
211 @property (nonatomic, assign) BOOL homonym;
213 @property (nonatomic, assign) BOOL isLightVersion;
216 @property (nonatomic, assign) BOOL showPhotos;
218 @property (nonatomic, assign) NSInteger pageIndex;
220 @property (nonatomic, assign) NSInteger pageSize;
222 @property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
224 @property (nonatomic, assign) BMKLanguageType languageType;
226 @property (nonatomic, assign) BMKSearchServiceRegionType serverType;
228 @property (nonatomic, assign) BOOL extensionsAdcode;
230 @property (nonatomic, assign) BOOL extensionsChildPoi;
231 @end
232
233
234 #pragma mark - POI矩形区域检索参数信息类
235 @interface BMKPOIBoundSearchOption : NSObject
242 @property (nonatomic, copy) NSArray<NSString *> *keywords;
244 @property (nonatomic, copy) NSString *type;
250 @property (nonatomic, copy) NSArray<NSString *> *tags;
252 @property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
254 @property (nonatomic, assign) CLLocationCoordinate2D rightTop;
256 @property (nonatomic, assign) BMKPOISearchScopeType scope;
258 @property (nonatomic, strong) BMKPOISearchFilter *filter;
261 @property (nonatomic, assign) BOOL addressResult;
263 @property (nonatomic, assign) BOOL homonym;
265 @property (nonatomic, assign) BOOL isLightVersion;
268 @property (nonatomic, assign) BOOL showPhotos;
270 @property (nonatomic, assign) NSInteger pageIndex;
272 @property (nonatomic, assign) NSInteger pageSize;
274 @property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
276 @property (nonatomic, assign) BMKLanguageType languageType;
278 @property (nonatomic, assign) BMKSearchServiceRegionType serverType;
280 @property (nonatomic, assign) BOOL extensionsAdcode;
282 @property (nonatomic, assign) BOOL extensionsChildPoi;
283 @end
284
285
286 #pragma mark - POI详情检索参数信息类
287 @interface BMKPOIDetailSearchOption : NSObject
290 @property (nonatomic, copy) NSArray<NSString *> *poiUIDs;
292 @property (nonatomic, assign) BMKPOISearchScopeType scope;
295 @property (nonatomic, assign) BOOL showPhotos;
297 @property (nonatomic, assign) BOOL extensionsAdcode;
299 @property (nonatomic, assign) BMKLanguageType languageType;
301 @property (nonatomic, assign) BMKSearchServiceRegionType serverType;
302 @end
303
304
305 #pragma mark - POI室内检索参数信息类
306 @interface BMKPOIIndoorSearchOption : NSObject
309 @property (nonatomic, copy) NSString *indoorID;
311 @property (nonatomic, copy) NSString *keyword;
313 @property (nonatomic, copy) NSString *floor;
315 @property (nonatomic, assign) NSInteger pageIndex;
317 @property (nonatomic, assign) NSInteger pageSize;
318 @end
BMKPOISearchFilter::isGroupon
BOOL isGroupon
是否有团购
Definition: BMKPoiSearchOption.h:110
BMKPOIDetailSearchOption
POI详情检索信息类
Definition: BMKPoiSearchOption.h:289
NS_ENUM
typedef NS_ENUM(NSUInteger, BMKPOIIndustryType)
Definition: BMKPoiSearchOption.h:25
BMKPOISearchFilter::isDiscount
BOOL isDiscount
是否有打折
Definition: BMKPoiSearchOption.h:112
BMKPOISearchFilter
Definition: BMKPoiSearchOption.h:100
BMKPOICitySearchOption
POI城市检索参数信息类
Definition: BMKPoiSearchOption.h:119
BMKPOISearchFilter::sortBasis
BMKPOISortBasisType sortBasis
Definition: BMKPoiSearchOption.h:106
BMKPOIIndoorSearchOption
室内POI检索参数信息类
Definition: BMKPoiSearchOption.h:308
BMKLanguageType
BMKLanguageType
语言类型枚举
Definition: BMKTypes.h:35
BMKPOINearbySearchOption
POI周边检索参数信息类
Definition: BMKPoiSearchOption.h:176
BMKPOIBoundSearchOption
POI矩形区域检索参数信息类
Definition: BMKPoiSearchOption.h:237
BMKPOISearchFilter::sortRule
BMKPOISortRuleType sortRule
排序规则
Definition: BMKPoiSearchOption.h:108
BMKPOISearchFilter::industryType
BMKPOIIndustryType industryType
POI所属行业类型，设置该字段可提高检索速度和过滤经度
Definition: BMKPoiSearchOption.h:101
BMKPoiSearchType.h