BaiduMap_IOSSDK_v6.2.0_Docs  6.2.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 
15 
16 #pragma mark - 枚举类型
24 typedef NS_ENUM(NSUInteger, BMKPOIIndustryType) {
25  BMK_POI_INDUSTRY_TYPE_HOTEL = 1,
26  BMK_POI_INDUSTRY_TYPE_CATER,
27  BMK_POI_INDUSTRY_TYPE_LIFE,
28 };
29 
52 typedef NS_ENUM(NSUInteger, BMKPOISortBasisType) {
53  BMK_POI_SORT_BASIS_TYPE_HOTEL_DEFAULT = 1,
54  BMK_POI_SORT_BASIS_TYPE_HOTEL_PRICE,
55  BMK_POI_SORT_BASIS_TYPE_HOTEL_DISTANCE,
56  BMK_POI_SORT_BASIS_TYPE_HOTEL_TOTAL_SCORE,
57  BMK_POI_SORT_BASIS_TYPE_HOTEL_LEVEL,
58  BMK_POI_SORT_BASIS_TYPE_HOTEL_HEALTH_SCORE,
59 
60  BMK_POI_SORT_BASIS_TYPE_CATER_DEFAULT = 10,
61  BMK_POI_SORT_BASIS_TYPE_CATER_PRICE,
62  BMK_POI_SORT_BASIS_TYPE_CATER_DISTANCE,
63  BMK_POI_SORT_BASIS_TYPE_CATER_TASTE_RATING,
64  BMK_POI_SORT_BASIS_TYPE_CATER_OVERALL_RATING,
65  BMK_POI_SORT_BASIS_TYPE_CATER_SERVICE_RATING,
66 
67  BMK_POI_SORT_BASIS_TYPE_LIFE_DEFAULT = 20,
68  BMK_POI_SORT_BASIS_TYPE_LIFE_PRICE,
69  BMK_POI_SORT_BASIS_TYPE_LIFE_DISTANCE,
70  BMK_POI_SORT_BASIS_TYPE_LIFE_OVERALL_RATING,
71  BMK_POI_SORT_BASIS_TYPE_LIFE_COMMENT_NUMBER,
72 };
73 
80 typedef NS_ENUM(NSUInteger, BMKPOISortRuleType) {
81  BMK_POI_SORT_RULE_DESCENDING = 0,
82  BMK_POI_SORT_RULE_ASCENDING,
83 };
84 
91 typedef NS_ENUM(NSUInteger, BMKPOISearchScopeType) {
92  BMK_POI_SCOPE_BASIC_INFORMATION = 1,
93  BMK_POI_SCOPE_DETAIL_INFORMATION,
94 };
95 
96 
97 #pragma mark - POI检索过滤条件类
98 @interface BMKPOISearchFilter : NSObject
100 @property (nonatomic, assign) BMKPOIIndustryType industryType;
105 @property (nonatomic, assign) BMKPOISortBasisType sortBasis;
107 @property (nonatomic, assign) BMKPOISortRuleType sortRule;
109 @property (nonatomic, assign) BOOL isGroupon;
111 @property (nonatomic, assign) BOOL isDiscount;
112 @end
113 
114 
115 #pragma mark - POI城市检索参数信息类
117 @interface BMKPOICitySearchOption : NSObject
119 @property (nonatomic, copy) NSString *keyword;
121 @property (nonatomic, copy) NSArray<NSString *> *tags;
123 @property (nonatomic, copy) NSString *city;
125 @property (nonatomic, assign) BOOL isCityLimit;
127 @property (nonatomic, assign) BMKPOISearchScopeType scope;
129 @property (nonatomic, strong) BMKPOISearchFilter *filter;
131 @property (nonatomic, assign) NSInteger pageIndex;
133 @property (nonatomic, assign) NSInteger pageSize;
134 @end
135 
136 
137 #pragma mark - POI周边检索参数信息类
139 @interface BMKPOINearbySearchOption : NSObject
145 @property (nonatomic, copy) NSArray<NSString *> *keywords;
151 @property (nonatomic, copy) NSArray<NSString *> *tags;
153 @property (nonatomic, assign) CLLocationCoordinate2D location;
158 @property (nonatomic, assign) NSInteger radius;
164 @property (nonatomic, assign) BOOL isRadiusLimit;
166 @property (nonatomic, assign) BMKPOISearchScopeType scope;
168 @property (nonatomic, strong) BMKPOISearchFilter *filter;
170 @property (nonatomic, assign) NSInteger pageIndex;
172 @property (nonatomic, assign) NSInteger pageSize;
173 @end
174 
175 
176 #pragma mark - POI矩形区域检索参数信息类
178 @interface BMKPOIBoundSearchOption : NSObject
184 @property (nonatomic, copy) NSArray<NSString *> *keywords;
190 @property (nonatomic, copy) NSArray<NSString *> *tags;
192 @property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
194 @property (nonatomic, assign) CLLocationCoordinate2D rightTop;
196 @property (nonatomic, assign) BMKPOISearchScopeType scope;
198 @property (nonatomic, strong) BMKPOISearchFilter *filter;
200 @property (nonatomic, assign) NSInteger pageIndex;
202 @property (nonatomic, assign) NSInteger pageSize;
203 @end
204 
205 
206 #pragma mark - POI详情检索参数信息类
208 @interface BMKPOIDetailSearchOption : NSObject
210 @property (nonatomic, copy) NSArray<NSString *> *poiUIDs;
212 @property (nonatomic, assign) BMKPOISearchScopeType scope;
213 @end
214 
215 
216 #pragma mark - POI室内检索参数信息类
218 @interface BMKPOIIndoorSearchOption : NSObject
220 @property (nonatomic, copy) NSString *indoorID;
222 @property (nonatomic, copy) NSString *keyword;
224 @property (nonatomic, copy) NSString *floor;
226 @property (nonatomic, assign) NSInteger pageIndex;
228 @property (nonatomic, assign) NSInteger pageSize;
229 @end
typedef NS_ENUM(NSUInteger, BMKPOIIndustryType)
Definition: BMKPoiSearchOption.h:24
POI矩形区域检索参数信息类
Definition: BMKPoiSearchOption.h:179
POI城市检索参数信息类
Definition: BMKPoiSearchOption.h:118
POI详情检索信息类
Definition: BMKPoiSearchOption.h:209
室内POI检索参数信息类
Definition: BMKPoiSearchOption.h:219
POI周边检索参数信息类
Definition: BMKPoiSearchOption.h:140
Definition: BMKPoiSearchOption.h:99
BOOL isGroupon
是否有团购
Definition: BMKPoiSearchOption.h:109
BMKPOISortBasisType sortBasis
Definition: BMKPoiSearchOption.h:105
BOOL isDiscount
是否有打折
Definition: BMKPoiSearchOption.h:111
BMKPOISortRuleType sortRule
排序规则
Definition: BMKPoiSearchOption.h:107
BMKPOIIndustryType industryType
POI所属行业类型,设置该字段可提高检索速度和过滤经度
Definition: BMKPoiSearchOption.h:100