PgyManager.h 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. //
  2. // PgyManager.h
  3. // PgySDK
  4. //
  5. // Created by Scott Lei on 2015-1-7.
  6. // Copyright (c) 2015年 蒲公英. All rights reserved.
  7. // Version: 2.3
  8. #import <Foundation/Foundation.h>
  9. #import <UIKit/UIKit.h>
  10. /**
  11. * 激活反馈功能的方式
  12. */
  13. typedef NS_ENUM(NSInteger, KPGYFeedbackActiveType){
  14. /**
  15. * 摇晃手机激活用户反馈界面
  16. */
  17. kPGYFeedbackActiveTypeShake = 0,
  18. /**
  19. * 在界面上三指下滑或者上滑激活用户反馈界面
  20. */
  21. kPGYFeedbackActiveTypeThreeFingersPan = 1,
  22. };
  23. @interface PgyManager : NSObject
  24. /**
  25. * 是否显示蒲公英SDK的Debug Log,如果遇到SDK无法正常工作的情况可以开启此标志以确认原因,默认为关闭。
  26. */
  27. @property (nonatomic, assign, getter = isDebugLogEnabled) BOOL enableDebugLog;
  28. /**
  29. * 激活用户反馈的方式,如果不设置的话,则默认为摇一摇激活用户反馈界面。
  30. * 设置激活用户反馈方式需在调用 - (void)startManagerWithAppId:(NSString *)appId 之前。
  31. */
  32. @property (nonatomic, assign) KPGYFeedbackActiveType feedbackActiveType;
  33. /**
  34. * 开启或关闭用户手势反馈功能,默认为开启。
  35. */
  36. @property (nonatomic, assign, getter=isFeedbackEnabled) BOOL enableFeedback;
  37. /**
  38. * 设置用户反馈界面的颜色,颜色会影响到Title以及工具栏的背景颜色和录音按钮的边框颜色,默认为黑色。
  39. */
  40. @property (nonatomic, retain) UIColor *themeColor;
  41. /**
  42. * 激活用户反馈界面的阈值,数字越小灵敏度越高,默认为2.3。
  43. */
  44. @property (nonatomic, assign) double shakingThreshold;
  45. /**
  46. * 初始化蒲公英SDK
  47. *
  48. * @return PgyManger的单例对象
  49. */
  50. + (PgyManager *)sharedPgyManager;
  51. /**
  52. * 启动蒲公英SDK
  53. * 如果需要自定义用户反馈激活模式,则需要在调用此方法之前设置。
  54. * @param appId 应用程序ID,从蒲公英网站上获取。
  55. */
  56. - (void)startManagerWithAppId:(NSString *)appId;
  57. /**
  58. * 显示用户反馈界面
  59. */
  60. - (void)showFeedbackView;
  61. /**
  62. * 上报Exception,Exception的name,reason,callStackSymbols会被上报至蒲公英服务器。
  63. *
  64. * @param exception 异常
  65. */
  66. - (void)reportException:(NSException *)exception;
  67. @end