123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 |
- //
- // AMapLocationManager.h
- // AMapLocationKit
- //
- // Created by AutoNavi on 15/10/22.
- // Copyright © 2015年 Amap. All rights reserved.
- //
- #import <UIKit/UIKit.h>
- #import <AMapFoundationKit/AMapServices.h>
- #import "AMapLocationCommonObj.h"
- #import "AMapLocationRegionObj.h"
- /**
- * @brief AMapLocatingCompletionBlock 单次定位返回Block
- * @param location 定位信息
- * @param regeocode 逆地理信息
- * @param error 错误信息,参考 AMapLocationErrorCode
- */
- typedef void (^AMapLocatingCompletionBlock)(CLLocation *location, AMapLocationReGeocode *regeocode, NSError *error);
- @protocol AMapLocationManagerDelegate;
- #pragma mark - AMapLocationManager
- ///AMapLocationManager类。初始化之前请设置 AMapServices 中的apikey(例如:[AMapServices sharedServices].apiKey = @"您的key"),否则将无法正常使用服务.
- @interface AMapLocationManager : NSObject
- ///实现了 AMapLocationManagerDelegate 协议的类指针。
- @property (nonatomic, weak) id<AMapLocationManagerDelegate> delegate;
- ///设定定位的最小更新距离。单位米,默认为 kCLDistanceFilterNone,表示只要检测到设备位置发生变化就会更新位置信息。
- @property(nonatomic, assign) CLLocationDistance distanceFilter;
- ///设定期望的定位精度。单位米,默认为 kCLLocationAccuracyBest。定位服务会尽可能去获取满足desiredAccuracy的定位结果,但不保证一定会得到满足期望的结果。
- ///注意:设置为kCLLocationAccuracyBest或kCLLocationAccuracyBestForNavigation时,单次定位会在达到locationTimeout设定的时间后,将时间内获取到的最高精度的定位结果返回。
- ///⚠️ 当iOS14及以上版本,模糊定位权限下可能拿不到设置精度的经纬度
- @property(nonatomic, assign) CLLocationAccuracy desiredAccuracy;
- ///指定定位是否会被系统自动暂停。默认为NO。
- @property(nonatomic, assign) BOOL pausesLocationUpdatesAutomatically;
- ///是否允许后台定位。默认为NO。只在iOS 9.0及之后起作用。设置为YES的时候必须保证 Background Modes 中的 Location updates 处于选中状态,否则会抛出异常。由于iOS系统限制,需要在定位未开始之前或定位停止之后,修改该属性的值才会有效果。
- @property(nonatomic, assign) BOOL allowsBackgroundLocationUpdates;
- ///指定单次定位超时时间,默认为10s。最小值是2s。注意单次定位请求前设置。注意: 单次定位超时时间从确定了定位权限(非kCLAuthorizationStatusNotDetermined状态)后开始计算。
- @property(nonatomic, assign) NSInteger locationTimeout;
- ///指定单次定位逆地理超时时间,默认为5s。最小值是2s。注意单次定位请求前设置。
- @property(nonatomic, assign) NSInteger reGeocodeTimeout;
- ///连续定位是否返回逆地理信息,默认NO。
- @property (nonatomic, assign) BOOL locatingWithReGeocode;
- ///逆地址语言类型,默认是AMapLocationRegionLanguageDefault
- @property (nonatomic, assign) AMapLocationReGeocodeLanguage reGeocodeLanguage;
- ///获取被监控的region集合。
- @property (nonatomic, readonly, copy) NSSet *monitoredRegions;
- ///检测是否存在虚拟定位风险,默认为NO,不检测。 \n注意:设置为YES时,单次定位通过 AMapLocatingCompletionBlock 的error给出虚拟定位风险提示;连续定位通过 amapLocationManager:didFailWithError: 方法的error给出虚拟定位风险提示。error格式为 error.domain==AMapLocationErrorDomain; error.code==AMapLocationErrorRiskOfFakeLocation; \n附带的error的详细信息参考 error.localizedDescription 中的描述以及 error.userInfo 中的信息(error.userInfo.AMapLocationRiskyLocateResult 表示有虚拟风险的定位结果; error.userInfo.AMapLocationAccessoryInfo 表示外接辅助设备信息)。
- @property (nonatomic, assign) BOOL detectRiskOfFakeLocation;
- #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 140000
- /**
- * @brief 设置定位数据回调精度模式,默认为AMapLocationAccuracyFullAndReduce。\n
- 注意:如果定位时未获得定位权限,则首先会调用申请定位权限API,实际定位精度权限取决于用户的权限设置。\n
- * ————————————————————————————————————————————————————————————————\n
- * | 设置选项 | doRequireTemporaryFullAccuracyAuth | 异常/定位数据回调 |\n
- * | AMapLocationFullAndReduceAccuracy | 会触发申请临时精确定位回调 | 如果未获得精确定位权限,则依然开启定位,回调模糊定位 |\n
- * | AMapLocationFullAccuracy | 会触发申请临时精确定位回调 | 如果未获得精确定位权限,则不开启定位,回调error |\n
- * | AMapLocationReduceAccuracy | 不会触发申请临时精确定位回调 | 根据当前定位精度权限,回调定位数据 |\n
- * ————————————————————————————————————————————————————————————————\n
- * 当设置AMapLocationFullAndReduceAccuracy时,定位数据回调可通过currentAuthorization判断当前是否是精确定位
- * @since 2.6.7
- */
- @property (nonatomic, assign) AMapLocationAccuracyMode locationAccuracyMode API_AVAILABLE(ios(14.0));
- /**
- * @brief 获取当前定位精度权限。
- * @since 2.6.7
- */
- @property (nonatomic, readonly) CLAccuracyAuthorization currentAuthorization API_AVAILABLE(ios(14.0));
- #endif
- /**
- * @brief 设备是否支持方向识别
- * @return YES:设备支持方向识别 ; NO:设备不支持支持方向识别
- */
- + (BOOL)headingAvailable;
- /**
- * @brief 开始获取设备朝向,如果设备支持方向识别,则会通过代理回调方法
- */
- - (void)startUpdatingHeading;
- /**
- * @brief 停止获取设备朝向
- */
- - (void)stopUpdatingHeading;
- /**
- * @brief 停止设备朝向校准显示
- */
- - (void)dismissHeadingCalibrationDisplay;
- /**
- * @brief 单次定位。如果当前正在连续定位,调用此方法将会失败,返回NO。\n该方法将会根据设定的 desiredAccuracy 去获取定位信息。如果获取的定位信息精确度低于 desiredAccuracy ,将会持续的等待定位信息,直到超时后通过completionBlock返回精度最高的定位信息。\n可以通过 stopUpdatingLocation 方法去取消正在进行的单次定位请求。
- * @param withReGeocode 是否带有逆地理信息(获取逆地理信息需要联网)
- * @param completionBlock 单次定位完成后的Block
- * @return 是否成功添加单次定位Request
- */
- - (BOOL)requestLocationWithReGeocode:(BOOL)withReGeocode completionBlock:(AMapLocatingCompletionBlock)completionBlock;
- /**
- * @brief 开始连续定位。调用此方法会cancel掉所有的单次定位请求。
- */
- - (void)startUpdatingLocation;
- /**
- * @brief 停止连续定位。调用此方法会cancel掉所有的单次定位请求,可以用来取消单次定位。
- */
- - (void)stopUpdatingLocation;
- /**
- * @brief 开始监控指定的region。如果已经存在相同identifier的region,则之前的region将会被移除。对 AMapLocationCircleRegion 类实例,将会优先监控radius小的region。
- * @param region 要被监控的范围
- */
- - (void)startMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 停止监控指定的region
- * @param region 要停止监控的范围
- */
- - (void)stopMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 查询一个region的当前状态。查询结果通过amapLocationManager:didDetermineState:forRegion:回调返回
- * @param region 要查询的region
- */
- - (void)requestStateForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- #pragma mark - Privacy 隐私合规
- /**
- * @brief 更新App是否显示隐私弹窗的状态,隐私弹窗是否包含高德SDK隐私协议内容的状态,注意:必须在AMapLocationManager实例化之前调用. since 2.8.0
- * @param showStatus 隐私弹窗状态
- * @param containStatus 包含高德SDK隐私协议状态
- */
- + (void)updatePrivacyShow:(AMapPrivacyShowStatus)showStatus privacyInfo:(AMapPrivacyInfoStatus)containStatus;
- /**
- * @brief 更新用户授权高德SDK隐私协议状态,注意:必须在AMapLocationManager实例化之前调用. since 2.8.0
- * @param agreeStatus 用户授权高德SDK隐私协议状态
- */
- + (void)updatePrivacyAgree:(AMapPrivacyAgreeStatus)agreeStatus;
- @end
- #pragma mark - AMapLocationManagerDelegate
- ///AMapLocationManagerDelegate 协议定义了发生错误时的错误回调方法,连续定位的回调方法等。
- @protocol AMapLocationManagerDelegate <NSObject>
- @optional
- #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 140000
- /**
- * @brief 触发前提条件:1、plist配置NSLocationTemporaryUsageDescriptionDictionary。2、locationAccuracyMode设置为AMapLocationFullAndReduceAccuracy/AMapLocationFullAccuracy。3、当前用户已授权过定位权限,且为模糊定位权限。触发时机:满足前提条件时,再次发起定位请求会调用代理的此方法。此方法实现调用申请临时精确定位权限API即可:
- * [manager requestTemporaryFullAccuracyAuthorizationWithPurposeKey:@"PurposeKey" completion:^(NSError *error){
- * if(completion){
- * completion(error);
- * }
- * }]; (必须调用,不然无法正常获取临时精确定位权限)
- * @param manager 定位 AMapLocationManager 类。
- * @param locationManager 需要申请临时精确定位权限的locationManager。
- * @param completion 临时精确定位权限API回调结果,error: 直接返回系统error即可。
- * @since 2.6.7
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager doRequireTemporaryFullAccuracyAuth:(CLLocationManager*)locationManager completion:(void(^)(NSError *error))completion;
- #endif
- /**
- * @brief 当plist配置NSLocationAlwaysUsageDescription或者NSLocationAlwaysAndWhenInUseUsageDescription,并且[CLLocationManager authorizationStatus] == kCLAuthorizationStatusNotDetermined,会调用代理的此方法。
- 此方法实现调用申请后台权限API即可:[locationManager requestAlwaysAuthorization] (必须调用,不然无法正常获取定位权限)
- * @param manager 定位 AMapLocationManager 类。
- * @param locationManager 需要申请后台定位权限的locationManager。
- * @since 2.6.2
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager doRequireLocationAuth:(CLLocationManager*)locationManager;
- /**
- * @brief 当定位发生错误时,会调用代理的此方法。
- * @param manager 定位 AMapLocationManager 类。
- * @param error 返回的错误,参考 CLError 。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didFailWithError:(NSError *)error;
- /**
- * @brief 连续定位回调函数.注意:本方法已被废弃,如果实现了amapLocationManager:didUpdateLocation:reGeocode:方法,则本方法将不会回调。
- * @param manager 定位 AMapLocationManager 类。
- * @param location 定位结果。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateLocation:(CLLocation *)location;
- /**
- * @brief 连续定位回调函数.注意:如果实现了本方法,则定位信息不会通过amapLocationManager:didUpdateLocation:方法回调。
- * @param manager 定位 AMapLocationManager 类。
- * @param location 定位结果。
- * @param reGeocode 逆地理信息。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateLocation:(CLLocation *)location reGeocode:(AMapLocationReGeocode *)reGeocode;
- /**
- * @brief 定位权限状态改变时回调函数。注意:iOS13及之前版本回调
- * @param manager 定位 AMapLocationManager 类。
- * @param status 定位权限状态。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status;
- /**
- * @brief 定位权限状态改变时回调函数。注意:iOS14及之后版本回调
- * @param manager 定位 AMapLocationManager 类。
- * @param locationManager 定位CLLocationManager类,可通过locationManager.authorizationStatus获取定位权限,通过locationManager.accuracyAuthorization获取定位精度权限
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager locationManagerDidChangeAuthorization:(CLLocationManager*)locationManager;
- /**
- * @brief 是否显示设备朝向校准
- * @param manager 定位 AMapLocationManager 类。
- * @return 是否显示设备朝向校准
- */
- - (BOOL)amapLocationManagerShouldDisplayHeadingCalibration:(AMapLocationManager *)manager;
- /**
- * @brief 设备方向改变时回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param newHeading 设备朝向。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateHeading:(CLHeading *)newHeading;
- /**
- * @brief 开始监控region回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param region 开始监控的region。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didStartMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 进入region回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param region 进入的region。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didEnterRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 离开region回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param region 离开的region。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didExitRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 查询region状态回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param state 查询的region的状态。
- * @param region 查询的region。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager didDetermineState:(AMapLocationRegionState)state forRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
- /**
- * @brief 监控region失败回调函数
- * @param manager 定位 AMapLocationManager 类。
- * @param region 失败的region。
- * @param error 错误信息,参考 AMapLocationErrorCode 。
- */
- - (void)amapLocationManager:(AMapLocationManager *)manager monitoringDidFailForRegion:(AMapLocationRegion *)region withError:(NSError *)error __attribute__((deprecated("请使用AMapGeoFenceManager")));
- @end
|