AMapNearbySearchManager.h 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. //
  2. // AMapNearbySearchManager.h
  3. // AMapSearchKit
  4. //
  5. // Created by xiaoming han on 15/8/31.
  6. // Copyright (c) 2015年 Amap. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "AMapNearbyUploadInfo.h"
  10. @class AMapNearbySearchManager;
  11. ///附近搜索代理
  12. @protocol AMapNearbySearchManagerDelegate <NSObject>
  13. @optional
  14. /**
  15. * @brief 开启自动上传,需实现该回调。
  16. */
  17. - (AMapNearbyUploadInfo *)nearbyInfoForUploading:(AMapNearbySearchManager *)manager;
  18. /**
  19. * @brief 用户信息上传完毕回调。
  20. * @param error 错误,为空时表示成功。
  21. */
  22. - (void)onNearbyInfoUploadedWithError:(NSError *)error;
  23. /**
  24. * @brief 用户信息清除完毕回调。
  25. * @param error 错误,为空时表示成功。
  26. */
  27. - (void)onUserInfoClearedWithError:(NSError *)error;
  28. @end
  29. ///附近搜索管理类,同时只能有一个实例开启,否则可能会出现错误。
  30. @interface AMapNearbySearchManager : NSObject
  31. ///上传最小间隔,默认15s,最小7s。自动上传的过程中设置无效。
  32. @property (nonatomic, assign) NSTimeInterval uploadTimeInterval;
  33. ///代理对象。
  34. @property (nonatomic, weak) id<AMapNearbySearchManagerDelegate> delegate;
  35. ///是否正在自动上传状态中。
  36. @property (nonatomic, readonly) BOOL isAutoUploading;
  37. /**
  38. * @brief manager单例.
  39. * 初始化之前请设置key,否则将无法正常使用该服务.
  40. * @return nearbySearch实例。
  41. */
  42. + (instancetype)sharedInstance;
  43. /**
  44. * @brief 请使用单例。
  45. */
  46. - (instancetype)init __attribute__((unavailable));
  47. /**
  48. * @brief 启动自动上传。
  49. */
  50. - (void)startAutoUploadNearbyInfo;
  51. /**
  52. * @brief 关闭自动上传。
  53. */
  54. - (void)stopAutoUploadNearbyInfo;
  55. /**
  56. * @brief 执行单次上传,执行间隔不低于uploadTimeInterval最小值,否则执行失败。
  57. * @param info 需要上传的信息。
  58. * @return 成功执行返回YES,否则返回NO。
  59. */
  60. - (BOOL)uploadNearbyInfo:(AMapNearbyUploadInfo *)info __attribute((deprecated("已废弃 since 7.4.0,该功能不再支持")));
  61. /**
  62. * @brief 清除服务器上某一用户的信息。
  63. * @param userID 指定的用户ID
  64. * @return 成功执行返回YES,否则返回NO。
  65. */
  66. - (BOOL)clearUserInfoWithID:(NSString *)userID __attribute((deprecated("已废弃 since 7.4.0,该功能不再支持")));
  67. @end