BMKPoiSearchOption.h

浏览该文件的文档.

//
//  BMKPOISearchOption.h
//  SearchComponent
//
//  本文件中包含了5种POI检索对应的请求参数信息类，以及其中用到的参数类、枚举等。
//  请求参数信息类的命名规则统一为 BMKPOIXXXSearchOption
//
//  Created by Baidu on 2018/5/8.
//  Copyright © 2018年 Baidu. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "BMKPoiSearchType.h"
#import <BaiduMapAPI_Base/BMKTypes.h>
 
 
#pragma mark - 枚举类型
typedef NS_ENUM(NSUInteger, BMKPOIIndustryType) {
    BMK_POI_INDUSTRY_TYPE_HOTEL = 1,
    BMK_POI_INDUSTRY_TYPE_CATER,
    BMK_POI_INDUSTRY_TYPE_LIFE,
};
 
typedef NS_ENUM(NSUInteger, BMKPOISortBasisType) {
    BMK_POI_SORT_BASIS_TYPE_HOTEL_DEFAULT = 1,
    BMK_POI_SORT_BASIS_TYPE_HOTEL_PRICE,
    BMK_POI_SORT_BASIS_TYPE_HOTEL_DISTANCE,
    BMK_POI_SORT_BASIS_TYPE_HOTEL_TOTAL_SCORE,
    BMK_POI_SORT_BASIS_TYPE_HOTEL_LEVEL,
    BMK_POI_SORT_BASIS_TYPE_HOTEL_HEALTH_SCORE,
    
    BMK_POI_SORT_BASIS_TYPE_CATER_DEFAULT = 10,
    BMK_POI_SORT_BASIS_TYPE_CATER_PRICE,
    BMK_POI_SORT_BASIS_TYPE_CATER_DISTANCE,
    BMK_POI_SORT_BASIS_TYPE_CATER_TASTE_RATING,
    BMK_POI_SORT_BASIS_TYPE_CATER_OVERALL_RATING,
    BMK_POI_SORT_BASIS_TYPE_CATER_SERVICE_RATING,
    
    BMK_POI_SORT_BASIS_TYPE_LIFE_DEFAULT = 20,
    BMK_POI_SORT_BASIS_TYPE_LIFE_PRICE,
    BMK_POI_SORT_BASIS_TYPE_LIFE_DISTANCE,
    BMK_POI_SORT_BASIS_TYPE_LIFE_OVERALL_RATING,
    BMK_POI_SORT_BASIS_TYPE_LIFE_COMMENT_NUMBER,
};
 
typedef NS_ENUM(NSUInteger, BMKPOISortRuleType) {
    BMK_POI_SORT_RULE_DESCENDING = 0,
    BMK_POI_SORT_RULE_ASCENDING,
};
 
typedef NS_ENUM(NSUInteger, BMKPOISearchScopeType) {
    BMK_POI_SCOPE_BASIC_INFORMATION = 1,
    BMK_POI_SCOPE_DETAIL_INFORMATION,
};
 
typedef NS_ENUM(NSUInteger, BMKPOISearchServerType) {
    BMK_POI_SEARCH_SERVER_DEFAULT = 0,
    BMK_POI_SEARCH_SERVER_ABROAD,
};
 
 
#pragma mark - POI检索过滤条件类
@interface BMKPOISearchFilter : NSObject
@property (nonatomic, assign) BMKPOIIndustryType industryType;
@property (nonatomic, assign) BMKPOISortBasisType sortBasis;
@property (nonatomic, assign) BMKPOISortRuleType sortRule;
@property (nonatomic, assign) BOOL isGroupon;
@property (nonatomic, assign) BOOL isDiscount;
@end
 
 
#pragma mark - POI城市检索参数信息类
@interface BMKPOICitySearchOption : NSObject
@property (nonatomic, copy) NSString *keyword;
@property (nonatomic, copy) NSString *type;
@property (nonatomic, copy) NSArray<NSString *> *tags;
@property (nonatomic, copy) NSString *city;
@property (nonatomic, assign) BOOL isCityLimit;
@property (nonatomic, assign) BMKPOISearchScopeType scope;
@property (nonatomic, strong) BMKPOISearchFilter *filter;
@property (nonatomic, assign) BOOL addressResult;
@property (nonatomic, assign) BOOL homonym;
@property (nonatomic, assign) BOOL isLightVersion;
@property (nonatomic, assign) CLLocationCoordinate2D location;
 
@property (nonatomic, assign) NSInteger filterDistance;
@property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
@property (nonatomic, assign) CLLocationCoordinate2D rightTop;
@property (nonatomic, assign) BOOL isBoundLimit;
 
@property (nonatomic, assign) BOOL showPhotos;
@property (nonatomic, assign) NSInteger pageIndex;
@property (nonatomic, assign) NSInteger pageSize;
@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
@property (nonatomic, assign) BMKLanguageType languageType;
@property (nonatomic, assign) BMKPOISearchServerType serverType;
@property (nonatomic, assign) BOOL extensionsAdcode;
@property (nonatomic, assign) BOOL extensionsChildPoi;
@end
 
 
#pragma mark - POI周边检索参数信息类
@interface BMKPOINearbySearchOption : NSObject
@property (nonatomic, copy) NSArray<NSString *> *keywords;
@property (nonatomic, copy) NSString *type;
@property (nonatomic, copy) NSArray<NSString *> *tags;
@property (nonatomic, assign) CLLocationCoordinate2D location;
@property (nonatomic, assign) NSInteger radius;
@property (nonatomic, assign) BOOL isRadiusLimit;
@property (nonatomic, assign) BMKPOISearchScopeType scope;
@property (nonatomic, strong) BMKPOISearchFilter *filter;
@property (nonatomic, assign) BOOL addressResult;
@property (nonatomic, assign) BOOL homonym;
@property (nonatomic, assign) BOOL isLightVersion;
@property (nonatomic, assign) BOOL showPhotos;
@property (nonatomic, assign) NSInteger pageIndex;
@property (nonatomic, assign) NSInteger pageSize;
@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
@property (nonatomic, assign) BMKLanguageType languageType;
@property (nonatomic, assign) BMKPOISearchServerType serverType;
@property (nonatomic, assign) BOOL extensionsAdcode;
@property (nonatomic, assign) BOOL extensionsChildPoi;
@end
 
 
#pragma mark - POI矩形区域检索参数信息类
@interface BMKPOIBoundSearchOption : NSObject
@property (nonatomic, copy) NSArray<NSString *> *keywords;
@property (nonatomic, copy) NSString *type;
@property (nonatomic, copy) NSArray<NSString *> *tags;
@property (nonatomic, assign) CLLocationCoordinate2D leftBottom;
@property (nonatomic, assign) CLLocationCoordinate2D rightTop;
@property (nonatomic, assign) BMKPOISearchScopeType scope;
@property (nonatomic, strong) BMKPOISearchFilter *filter;
@property (nonatomic, assign) BOOL addressResult;
@property (nonatomic, assign) BOOL homonym;
@property (nonatomic, assign) BOOL isLightVersion;
@property (nonatomic, assign) BOOL showPhotos;
@property (nonatomic, assign) NSInteger pageIndex;
@property (nonatomic, assign) NSInteger pageSize;
@property (nonatomic, assign) BMKInputLanguageType inputLanguageType;
@property (nonatomic, assign) BMKLanguageType languageType;
@property (nonatomic, assign) BMKPOISearchServerType serverType;
@property (nonatomic, assign) BOOL extensionsAdcode;
@property (nonatomic, assign) BOOL extensionsChildPoi;
@end
 
 
#pragma mark - POI详情检索参数信息类
@interface BMKPOIDetailSearchOption : NSObject
@property (nonatomic, copy) NSArray<NSString *> *poiUIDs;
@property (nonatomic, assign) BMKPOISearchScopeType scope;
@property (nonatomic, assign) BOOL showPhotos;
@property (nonatomic, assign) BOOL extensionsAdcode;
@property (nonatomic, assign) BMKLanguageType languageType;
@property (nonatomic, assign) BMKPOISearchServerType serverType;
@end
 
 
#pragma mark - POI室内检索参数信息类
@interface BMKPOIIndoorSearchOption : NSObject
@property (nonatomic, copy) NSString *indoorID;
@property (nonatomic, copy) NSString *keyword;
@property (nonatomic, copy) NSString *floor;
@property (nonatomic, assign) NSInteger pageIndex;
@property (nonatomic, assign) NSInteger pageSize;
@end