BaiduMap_IOSSDK_v6.6.6_Docs 6.6.6

载入中...
搜索中...
未找到
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 - 枚举类型
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
103 typedef NS_ENUM(NSUInteger, BMKPOISearchServerType) {
104 BMK_POI_SEARCH_SERVER_DEFAULT = 0,
105 BMK_POI_SEARCH_SERVER_ABROAD,
106};
107
108
109#pragma mark - POI检索过滤条件类
110@interface BMKPOISearchFilter : NSObject
112@property (nonatomic, assign) BMKPOIIndustryType industryType;
117@property (nonatomic, assign) BMKPOISortBasisType sortBasis;
119@property (nonatomic, assign) BMKPOISortRuleType sortRule;
121@property (nonatomic, assign) BOOL isGroupon;
123@property (nonatomic, assign) BOOL isDiscount;
124@end
125
126
127#pragma mark - POI城市检索参数信息类
129@interface BMKPOICitySearchOption : NSObject
131@property (nonatomic, copy) NSString *keyword;
133@property (nonatomic, copy) NSString *type;
135@property (nonatomic, copy) NSArray<NSString *> *tags;
137@property (nonatomic, copy) NSString *city;
139@property (nonatomic, assign) BOOL isCityLimit;
141@property (nonatomic, assign) BMKPOISearchScopeType scope;
143@property (nonatomic, strong) BMKPOISearchFilter *filter;
146@property (nonatomic, assign) BOOL addressResult;
148@property (nonatomic, assign) BOOL homonym;
150@property (nonatomic, assign) BOOL isLightVersion;
152@property (nonatomic, assign) CLLocationCoordinate2D location;
153
156@property (nonatomic, assign) NSInteger filterDistance;
158@property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
160@property (nonatomic, assign) CLLocationCoordinate2D rightTop;
162@property (nonatomic, assign) BOOL isBoundLimit;
163
166@property (nonatomic, assign) BOOL showPhotos;
168@property (nonatomic, assign) NSInteger pageIndex;
170@property (nonatomic, assign) NSInteger pageSize;
172@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
174@property (nonatomic, assign) BMKLanguageType languageType;
176@property (nonatomic, assign) BMKPOISearchServerType serverType;
178@property (nonatomic, assign) BOOL extensionsAdcode;
180@property (nonatomic, assign) BOOL extensionsChildPoi;
181@end
182
183
184#pragma mark - POI周边检索参数信息类
186@interface BMKPOINearbySearchOption : NSObject
192@property (nonatomic, copy) NSArray<NSString *> *keywords;
194@property (nonatomic, copy) NSString *type;
200@property (nonatomic, copy) NSArray<NSString *> *tags;
202@property (nonatomic, assign) CLLocationCoordinate2D location;
207@property (nonatomic, assign) NSInteger radius;
213@property (nonatomic, assign) BOOL isRadiusLimit;
215@property (nonatomic, assign) BMKPOISearchScopeType scope;
217@property (nonatomic, strong) BMKPOISearchFilter *filter;
220@property (nonatomic, assign) BOOL addressResult;
222@property (nonatomic, assign) BOOL homonym;
224@property (nonatomic, assign) BOOL isLightVersion;
227@property (nonatomic, assign) BOOL showPhotos;
229@property (nonatomic, assign) NSInteger pageIndex;
231@property (nonatomic, assign) NSInteger pageSize;
233@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
235@property (nonatomic, assign) BMKLanguageType languageType;
237@property (nonatomic, assign) BMKPOISearchServerType serverType;
239@property (nonatomic, assign) BOOL extensionsAdcode;
241@property (nonatomic, assign) BOOL extensionsChildPoi;
242@end
243
244
245#pragma mark - POI矩形区域检索参数信息类
247@interface BMKPOIBoundSearchOption : NSObject
253@property (nonatomic, copy) NSArray<NSString *> *keywords;
255@property (nonatomic, copy) NSString *type;
261@property (nonatomic, copy) NSArray<NSString *> *tags;
263@property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
265@property (nonatomic, assign) CLLocationCoordinate2D rightTop;
267@property (nonatomic, assign) BMKPOISearchScopeType scope;
269@property (nonatomic, strong) BMKPOISearchFilter *filter;
272@property (nonatomic, assign) BOOL addressResult;
274@property (nonatomic, assign) BOOL homonym;
276@property (nonatomic, assign) BOOL isLightVersion;
279@property (nonatomic, assign) BOOL showPhotos;
281@property (nonatomic, assign) NSInteger pageIndex;
283@property (nonatomic, assign) NSInteger pageSize;
285@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
287@property (nonatomic, assign) BMKLanguageType languageType;
289@property (nonatomic, assign) BMKPOISearchServerType serverType;
291@property (nonatomic, assign) BOOL extensionsAdcode;
293@property (nonatomic, assign) BOOL extensionsChildPoi;
294@end
295
296
297#pragma mark - POI详情检索参数信息类
299@interface BMKPOIDetailSearchOption : NSObject
301@property (nonatomic, copy) NSArray<NSString *> *poiUIDs;
303@property (nonatomic, assign) BMKPOISearchScopeType scope;
306@property (nonatomic, assign) BOOL showPhotos;
308@property (nonatomic, assign) BOOL extensionsAdcode;
310@property (nonatomic, assign) BMKLanguageType languageType;
312@property (nonatomic, assign) BMKPOISearchServerType serverType;
313@end
314
315
316#pragma mark - POI室内检索参数信息类
318@interface BMKPOIIndoorSearchOption : NSObject
320@property (nonatomic, copy) NSString *indoorID;
322@property (nonatomic, copy) NSString *keyword;
324@property (nonatomic, copy) NSString *floor;
326@property (nonatomic, assign) NSInteger pageIndex;
328@property (nonatomic, assign) NSInteger pageSize;
329@end
NS_ENUM
typedef NS_ENUM(NSUInteger, BMKPOIIndustryType)
Definition BMKPoiSearchOption.h:25
BMKPoiSearchType.h
BMKLanguageType
BMKLanguageType
语言类型枚举
Definition BMKTypes.h:28
BMKPOIBoundSearchOption
POI矩形区域检索参数信息类
Definition BMKPoiSearchOption.h:248
BMKPOICitySearchOption
POI城市检索参数信息类
Definition BMKPoiSearchOption.h:130
BMKPOIDetailSearchOption
POI详情检索信息类
Definition BMKPoiSearchOption.h:300
BMKPOIIndoorSearchOption
室内POI检索参数信息类
Definition BMKPoiSearchOption.h:319
BMKPOINearbySearchOption
POI周边检索参数信息类
Definition BMKPoiSearchOption.h:187
BMKPOISearchFilter
Definition BMKPoiSearchOption.h:111
BMKPOISearchFilter::isGroupon
BOOL isGroupon
是否有团购
Definition BMKPoiSearchOption.h:121
BMKPOISearchFilter::sortBasis
BMKPOISortBasisType sortBasis
Definition BMKPoiSearchOption.h:117
BMKPOISearchFilter::isDiscount
BOOL isDiscount
是否有打折
Definition BMKPoiSearchOption.h:123
BMKPOISearchFilter::sortRule
BMKPOISortRuleType sortRule
排序规则
Definition BMKPoiSearchOption.h:119
BMKPOISearchFilter::industryType
BMKPOIIndustryType industryType
POI所属行业类型，设置该字段可提高检索速度和过滤经度
Definition BMKPoiSearchOption.h:112