百度定位SDK for iOS v2.0 类参考
BMKLocationManager.h
1 //
2 // BMKLocationManager.h
3 // BMKLocationKit
4 //
5 // Created by baidu on 2017/3/2.
6 // Copyright © 2017年 baidu. All rights reserved.
7 //
8 
9 #import <Availability.h>
10 #import <Foundation/Foundation.h>
11 #import <CoreLocation/CoreLocation.h>
12 #import "BMKLocationReGeocode.h"
13 #import "BMKLocation.h"
14 
18 typedef NS_ENUM(NSUInteger, BMKLocationCoordinateType)
19 {
20  BMKLocationCoordinateTypeBMK09LL = 0,
21  BMKLocationCoordinateTypeBMK09MC,
22  BMKLocationCoordinateTypeWGS84,
23  BMKLocationCoordinateTypeGCJ02
24 };
25 
29 typedef NS_ENUM(int, BMKLocationNetworkState) {
30  BMKLocationNetworkStateUnknown = 0,
31  BMKLocationNetworkStateWifi,
32  BMKLocationNetworkStateWifiHotSpot,
33  BMKLocationNetworkStateMobile2G,
34  BMKLocationNetworkStateMobile3G,
35  BMKLocationNetworkStateMobile4G
36 
37 };
38 
39 
41 
42 FOUNDATION_EXPORT NSErrorDomain const _Nonnull BMKLocationErrorDomain;
43 
45 typedef NS_ENUM(NSInteger, BMKLocationErrorCode)
46 {
47  BMKLocationErrorUnKnown = 0,
48  BMKLocationErrorLocFailed = 1,
49  BMKLocationErrorDenied = 2,
50  BMKLocationErrorNetWork = 3,
51  BMKLocationErrorHeadingFailed = 4,
52  BMKLocationErrorGetExtraNetworkFailed = 5,
53  BMKLocationErrorGetExtraParseFailed = 6,
54  BMKLocationErrorFailureAuth = 7,
55 };
56 
60 typedef NS_ENUM(NSInteger, BMKLAccuracyAuthorization) {
61 
62  BMKLAccuracyAuthorizationFullAccuracy,
63  BMKLAccuracyAuthorizationReducedAccuracy,
64 };
65 
66 
73 typedef void (^BMKLocatingCompletionBlock)(BMKLocation * _Nullable location, BMKLocationNetworkState state , NSError * _Nullable error);
74 
75 
76 
77 @protocol BMKLocationManagerDelegate;
78 
79 #pragma mark - BMKLocationManager
80 
81 
83 @interface BMKLocationManager : NSObject
84 
86 @property (nonatomic, weak, nullable) id<BMKLocationManagerDelegate> delegate;
87 
89 @property(nonatomic, assign) CLLocationDistance distanceFilter;
90 
92 @property(nonatomic, assign) CLLocationAccuracy desiredAccuracy;
93 
95 @property(nonatomic, assign) CLActivityType activityType;
96 
98 @property(nonatomic, assign) BMKLocationCoordinateType coordinateType;
99 
101 @property(nonatomic, assign) BOOL pausesLocationUpdatesAutomatically;
102 
103 
105 @property(nonatomic, assign) BOOL allowsBackgroundLocationUpdates;
106 
108 @property(nonatomic, assign) NSInteger locationTimeout;
109 
111 @property(nonatomic, assign) NSInteger reGeocodeTimeout;
112 
114 @property (nonatomic, assign) BOOL locatingWithReGeocode;
115 
117 @property (nonatomic, assign) BOOL isNeedNewVersionReGeocode;
118 
119 
121 @property(nonatomic, copy, nullable) NSString * userID;
122 
124 @property (nonatomic, readonly) BMKLAccuracyAuthorization accuracyAuthorization;
125 
126 
134 - (BOOL)requestLocationWithReGeocode:(BOOL)withReGeocode withNetworkState:(BOOL)withNetWorkState completionBlock:(BMKLocatingCompletionBlock _Nonnull)completionBlock;
135 
139 - (void)startUpdatingLocation;
140 
144 - (void)stopUpdatingLocation;
145 
149 - (void)requestNetworkState;
150 
151 
156 + (BOOL)headingAvailable;
157 
161 - (void)startUpdatingHeading;
162 
166 - (void)stopUpdatingHeading;
167 
171 - (void)tryIndoorLocation;
172 
176 - (void)stopIndoorLocation;
177 
178 
186 + (CLLocationCoordinate2D) BMKLocationCoordinateConvert:(CLLocationCoordinate2D) coordinate SrcType:(BMKLocationCoordinateType)srctype DesType:(BMKLocationCoordinateType)destype;
187 
194 + (BOOL) BMKLocationDataAvailableForCoordinate:(CLLocationCoordinate2D)coordinate withCoorType:(BMKLocationCoordinateType)coortype;
195 
196 
197 
202 - (CLAuthorizationStatus)authorizationStatus;
203 
204 
211 - (void)requestTemporaryFullAccuracyAuthorizationWithPurposeKey:(NSString * _Nonnull)purposeKey completion:(void(^ _Nullable)(NSError * _Nullable))completion API_AVAILABLE(ios(14.0));
212 
218 - (void)requestTemporaryFullAccuracyAuthorizationWithPurposeKey:(NSString * _Nonnull)purposeKey API_AVAILABLE(ios(14.0));
219 
220 
221 @end
222 
223 #pragma mark - BMKLocationManagerDelegate
224 
225 
227 @protocol BMKLocationManagerDelegate <NSObject>
228 
229 @optional
230 
237 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager doRequestAlwaysAuthorization:(CLLocationManager * _Nonnull)locationManager;
238 
244 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager didFailWithError:(NSError * _Nullable)error;
245 
246 
253 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager didUpdateLocation:(BMKLocation * _Nullable)location orError:(NSError * _Nullable)error;
254 
260 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status API_DEPRECATED_WITH_REPLACEMENT("-bmkLocationManagerDidChangeAuthorization", ios(4.2, 14.0));
261 
262 
267 - (void)BMKLocationManagerDidChangeAuthorization:(BMKLocationManager * _Nonnull)manager API_AVAILABLE(ios(14.0));
268 
269 
274 - (BOOL)BMKLocationManagerShouldDisplayHeadingCalibration:(BMKLocationManager * _Nonnull)manager;
275 
281 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager
282  didUpdateHeading:(CLHeading * _Nullable)heading;
283 
290 - (void)BMKLocationManager:(BMKLocationManager * _Nonnull)manager
291  didUpdateNetworkState:(BMKLocationNetworkState)state orError:(NSError * _Nullable)error;
292 
293 
294 @end
295 
296 
void tryIndoorLocation()
该方法为BMKLocationManager尝试使用高精度室内定位。在特定的室内场景下会有更高精度的定位回调,只在室内...
BMKLocationCoordinateType coordinateType
设定定位坐标系类型。默认为 BMKLocationCoordinateTypeGCJ02。
Definition: BMKLocationManager.h:98
void stopUpdatingLocation()
停止连续定位。调用此方法会cancel掉所有的单次定位请求,可以用来取消单次定位。
void stopIndoorLocation()
该方法为BMKLocationManager会关闭高精度室内定位,只在室内定位版本生效。
void requestNetworkState()
请求网络状态结果回调。
BMKLocationManager类。初始化之前请设置 BMKLocationAuth 中的APIKey,否则将无法正常使用服务.
Definition: BMKLocationManager.h:83
id< BMKLocationManagerDelegate > delegate
实现了 BMKLocationManagerDelegate 协议的类指针。
Definition: BMKLocationManager.h:86
CLLocationAccuracy desiredAccuracy
设定定位精度。默认为 kCLLocationAccuracyBest。
Definition: BMKLocationManager.h:92
void stopUpdatingHeading()
该方法为BMKLocationManager停止设备朝向事件回调。
BOOL isNeedNewVersionReGeocode
定位sdk-v1.3之后,开发者可以选择是否需要最新版本rgc数据,1.9之后默认是需要YES;YES的情况下,定位sdk会...
Definition: BMKLocationManager.h:117
NSInteger locationTimeout
指定单次定位超时时间,默认为10s。最小值是2s。注意单次定位请求前设置。注意: 单次定位超时时间从确定了定...
Definition: BMKLocationManager.h:108
BOOL pausesLocationUpdatesAutomatically
指定定位是否会被系统自动暂停。默认为NO。
Definition: BMKLocationManager.h:101
void startUpdatingHeading()
该方法为BMKLocationManager开始设备朝向事件回调。
CLActivityType activityType
设定定位类型。默认为 CLActivityTypeAutomotiveNavigation。
Definition: BMKLocationManager.h:95
BOOL locatingWithReGeocode
连续定位是否返回逆地理信息,默认YES。
Definition: BMKLocationManager.h:114
NSString * userID
开发者可以指定该用户的id,用于后续统一识别用户,便于查找问题
Definition: BMKLocationManager.h:121
BMKLAccuracyAuthorization accuracyAuthorization
返回定位精度等级,IOS14之后用户可以直接控制返回定位的精度等级,开发者可以通过这个值适配不同定位等级下...
Definition: BMKLocationManager.h:124
BOOL headingAvailable()
该方法返回设备是否支持设备朝向事件回调。
描述百度iOS 定位数据
Definition: BMKLocation.h:27
NSInteger reGeocodeTimeout
指定单次定位逆地理超时时间,默认为10s。最小值是2s。注意单次定位请求前设置。
Definition: BMKLocationManager.h:111
CLAuthorizationStatus authorizationStatus()
返回当前定位权限
CLLocationDistance distanceFilter
设定定位的最小更新距离。默认为 kCLDistanceFilterNone。
Definition: BMKLocationManager.h:89
BOOL allowsBackgroundLocationUpdates
是否允许后台定位。默认为NO。只在iOS 9.0及之后起作用。设置为YES的时候必须保证 Background Modes 中的 Lo...
Definition: BMKLocationManager.h:105
void startUpdatingLocation()
开始连续定位。调用此方法会cancel掉所有的单次定位请求。