AMapLocationManager.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. //
  2. // AMapLocationManager.h
  3. // AMapLocationKit
  4. //
  5. // Created by AutoNavi on 15/10/22.
  6. // Copyright © 2015年 Amap. All rights reserved.
  7. //
  8. #import <UIKit/UIKit.h>
  9. #import "AMapLocationCommonObj.h"
  10. #import "AMapLocationRegionObj.h"
  11. /**
  12. * @brief AMapLocatingCompletionBlock 单次定位返回Block
  13. * @param location 定位信息
  14. * @param regeocode 逆地理信息
  15. * @param error 错误信息,参考 AMapLocationErrorCode
  16. */
  17. typedef void (^AMapLocatingCompletionBlock)(CLLocation *location, AMapLocationReGeocode *regeocode, NSError *error);
  18. @protocol AMapLocationManagerDelegate;
  19. #pragma mark - AMapLocationManager
  20. ///AMapLocationManager类。初始化之前请设置 AMapServices 中的apikey(例如:[AMapServices sharedServices].apiKey = @"您的key"),否则将无法正常使用服务.
  21. @interface AMapLocationManager : NSObject
  22. ///实现了 AMapLocationManagerDelegate 协议的类指针。
  23. @property (nonatomic, weak) id<AMapLocationManagerDelegate> delegate;
  24. ///设定定位的最小更新距离。单位米,默认为 kCLDistanceFilterNone,表示只要检测到设备位置发生变化就会更新位置信息。
  25. @property(nonatomic, assign) CLLocationDistance distanceFilter;
  26. ///设定期望的定位精度。单位米,默认为 kCLLocationAccuracyBest。定位服务会尽可能去获取满足desiredAccuracy的定位结果,但不保证一定会得到满足期望的结果。 \n注意:设置为kCLLocationAccuracyBest或kCLLocationAccuracyBestForNavigation时,单次定位会在达到locationTimeout设定的时间后,将时间内获取到的最高精度的定位结果返回。
  27. @property(nonatomic, assign) CLLocationAccuracy desiredAccuracy;
  28. ///指定定位是否会被系统自动暂停。默认为NO。
  29. @property(nonatomic, assign) BOOL pausesLocationUpdatesAutomatically;
  30. ///是否允许后台定位。默认为NO。只在iOS 9.0及之后起作用。设置为YES的时候必须保证 Background Modes 中的 Location updates 处于选中状态,否则会抛出异常。由于iOS系统限制,需要在定位未开始之前或定位停止之后,修改该属性的值才会有效果。
  31. @property(nonatomic, assign) BOOL allowsBackgroundLocationUpdates;
  32. ///指定单次定位超时时间,默认为10s。最小值是2s。注意单次定位请求前设置。注意: 单次定位超时时间从确定了定位权限(非kCLAuthorizationStatusNotDetermined状态)后开始计算。
  33. @property(nonatomic, assign) NSInteger locationTimeout;
  34. ///指定单次定位逆地理超时时间,默认为5s。最小值是2s。注意单次定位请求前设置。
  35. @property(nonatomic, assign) NSInteger reGeocodeTimeout;
  36. ///连续定位是否返回逆地理信息,默认NO。
  37. @property (nonatomic, assign) BOOL locatingWithReGeocode;
  38. // 逆地址语言类型,默认是AMapLocationRegionLanguageDefault
  39. @property (nonatomic, assign) AMapLocationReGeocodeLanguage reGeocodeLanguage;
  40. ///获取被监控的region集合。
  41. @property (nonatomic, readonly, copy) NSSet *monitoredRegions;
  42. ///检测是否存在虚拟定位风险,默认为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 表示外接辅助设备信息)。
  43. @property (nonatomic, assign) BOOL detectRiskOfFakeLocation;
  44. /**
  45. * @brief 设备是否支持方向识别
  46. * @return YES:设备支持方向识别 ; NO:设备不支持支持方向识别
  47. */
  48. + (BOOL)headingAvailable;
  49. /**
  50. * @brief 开始获取设备朝向,如果设备支持方向识别,则会通过代理回调方法
  51. */
  52. - (void)startUpdatingHeading;
  53. /**
  54. * @brief 停止获取设备朝向
  55. */
  56. - (void)stopUpdatingHeading;
  57. /**
  58. * @brief 停止设备朝向校准显示
  59. */
  60. - (void)dismissHeadingCalibrationDisplay;
  61. /**
  62. * @brief 单次定位。如果当前正在连续定位,调用此方法将会失败,返回NO。\n该方法将会根据设定的 desiredAccuracy 去获取定位信息。如果获取的定位信息精确度低于 desiredAccuracy ,将会持续的等待定位信息,直到超时后通过completionBlock返回精度最高的定位信息。\n可以通过 stopUpdatingLocation 方法去取消正在进行的单次定位请求。
  63. * @param withReGeocode 是否带有逆地理信息(获取逆地理信息需要联网)
  64. * @param completionBlock 单次定位完成后的Block
  65. * @return 是否成功添加单次定位Request
  66. */
  67. - (BOOL)requestLocationWithReGeocode:(BOOL)withReGeocode completionBlock:(AMapLocatingCompletionBlock)completionBlock;
  68. /**
  69. * @brief 开始连续定位。调用此方法会cancel掉所有的单次定位请求。
  70. */
  71. - (void)startUpdatingLocation;
  72. /**
  73. * @brief 停止连续定位。调用此方法会cancel掉所有的单次定位请求,可以用来取消单次定位。
  74. */
  75. - (void)stopUpdatingLocation;
  76. /**
  77. * @brief 开始监控指定的region。如果已经存在相同identifier的region,则之前的region将会被移除。对 AMapLocationCircleRegion 类实例,将会优先监控radius小的region。
  78. * @param region 要被监控的范围
  79. */
  80. - (void)startMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  81. /**
  82. * @brief 停止监控指定的region
  83. * @param region 要停止监控的范围
  84. */
  85. - (void)stopMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  86. /**
  87. * @brief 查询一个region的当前状态。查询结果通过amapLocationManager:didDetermineState:forRegion:回调返回
  88. * @param region 要查询的region
  89. */
  90. - (void)requestStateForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  91. @end
  92. #pragma mark - AMapLocationManagerDelegate
  93. ///AMapLocationManagerDelegate 协议定义了发生错误时的错误回调方法,连续定位的回调方法等。
  94. @protocol AMapLocationManagerDelegate <NSObject>
  95. @optional
  96. /**
  97. * @brief 当plist配置NSLocationAlwaysUsageDescription或者NSLocationAlwaysAndWhenInUseUsageDescription,并且[CLLocationManager authorizationStatus] == kCLAuthorizationStatusNotDetermined,会调用代理的此方法。
  98. 此方法实现调用申请后台权限API即可:[locationManager requestAlwaysAuthorization](必须调用,不然无法正常获取定位权限)
  99. * @param manager 定位 AMapLocationManager 类。
  100. * @param locationManager 需要申请后台定位权限的locationManager。
  101. * @since 2.6.2
  102. */
  103. - (void)amapLocationManager:(AMapLocationManager *)manager doRequireLocationAuth:(CLLocationManager*)locationManager;
  104. /**
  105. * @brief 当定位发生错误时,会调用代理的此方法。
  106. * @param manager 定位 AMapLocationManager 类。
  107. * @param error 返回的错误,参考 CLError 。
  108. */
  109. - (void)amapLocationManager:(AMapLocationManager *)manager didFailWithError:(NSError *)error;
  110. /**
  111. * @brief 连续定位回调函数.注意:本方法已被废弃,如果实现了amapLocationManager:didUpdateLocation:reGeocode:方法,则本方法将不会回调。
  112. * @param manager 定位 AMapLocationManager 类。
  113. * @param location 定位结果。
  114. */
  115. - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateLocation:(CLLocation *)location;
  116. /**
  117. * @brief 连续定位回调函数.注意:如果实现了本方法,则定位信息不会通过amapLocationManager:didUpdateLocation:方法回调。
  118. * @param manager 定位 AMapLocationManager 类。
  119. * @param location 定位结果。
  120. * @param reGeocode 逆地理信息。
  121. */
  122. - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateLocation:(CLLocation *)location reGeocode:(AMapLocationReGeocode *)reGeocode;
  123. /**
  124. * @brief 定位权限状态改变时回调函数
  125. * @param manager 定位 AMapLocationManager 类。
  126. * @param status 定位权限状态。
  127. */
  128. - (void)amapLocationManager:(AMapLocationManager *)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status;
  129. /**
  130. * @brief 是否显示设备朝向校准
  131. * @param manager 定位 AMapLocationManager 类。
  132. * @return 是否显示设备朝向校准
  133. */
  134. - (BOOL)amapLocationManagerShouldDisplayHeadingCalibration:(AMapLocationManager *)manager;
  135. /**
  136. * @brief 设备方向改变时回调函数
  137. * @param manager 定位 AMapLocationManager 类。
  138. * @param newHeading 设备朝向。
  139. */
  140. - (void)amapLocationManager:(AMapLocationManager *)manager didUpdateHeading:(CLHeading *)newHeading;
  141. /**
  142. * @brief 开始监控region回调函数
  143. * @param manager 定位 AMapLocationManager 类。
  144. * @param region 开始监控的region。
  145. */
  146. - (void)amapLocationManager:(AMapLocationManager *)manager didStartMonitoringForRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  147. /**
  148. * @brief 进入region回调函数
  149. * @param manager 定位 AMapLocationManager 类。
  150. * @param region 进入的region。
  151. */
  152. - (void)amapLocationManager:(AMapLocationManager *)manager didEnterRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  153. /**
  154. * @brief 离开region回调函数
  155. * @param manager 定位 AMapLocationManager 类。
  156. * @param region 离开的region。
  157. */
  158. - (void)amapLocationManager:(AMapLocationManager *)manager didExitRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  159. /**
  160. * @brief 查询region状态回调函数
  161. * @param manager 定位 AMapLocationManager 类。
  162. * @param state 查询的region的状态。
  163. * @param region 查询的region。
  164. */
  165. - (void)amapLocationManager:(AMapLocationManager *)manager didDetermineState:(AMapLocationRegionState)state forRegion:(AMapLocationRegion *)region __attribute__((deprecated("请使用AMapGeoFenceManager")));
  166. /**
  167. * @brief 监控region失败回调函数
  168. * @param manager 定位 AMapLocationManager 类。
  169. * @param region 失败的region。
  170. * @param error 错误信息,参考 AMapLocationErrorCode 。
  171. */
  172. - (void)amapLocationManager:(AMapLocationManager *)manager monitoringDidFailForRegion:(AMapLocationRegion *)region withError:(NSError *)error __attribute__((deprecated("请使用AMapGeoFenceManager")));
  173. @end