Ei kuvausta

WeiboSDK+Statistics.h 3.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // WeiboSDK+Statistics.h
  3. // WeiboSDK
  4. //
  5. // Created by DannionQiu on 15/4/13.
  6. // Copyright (c) 2015年 SINA iOS Team. All rights reserved.
  7. //
  8. #import "WeiboSDK.h"
  9. @interface WeiboSDK(Statistics)
  10. /** 设置是否开启统计模式, 默认为NO.
  11. @param value 为YES, SDK会开启统计功能,记录日志,并在合适的实际传上服务器。
  12. @return void.
  13. */
  14. + (void)setStatisticsEnabled:(BOOL)value;
  15. #pragma mark - Optional Configs Setting
  16. /** 设置是否打印SDK的log信息, 默认NO(不打印log).
  17. @param value 设置为YES, WeiboSDK 会输出log信息可供调试参考. 除非特殊需要,否则发布产品时需改回NO.
  18. @return void.
  19. */
  20. + (void)setStatisticsLogEnabled:(BOOL)value;
  21. /** 设置版本信息.
  22. @param version 版本号,为nil或@""时, 默认为Build号(CFBundleVersion)
  23. @return void.
  24. */
  25. + (void)setVersion:(NSString*)version;
  26. /** 设置渠道信息.
  27. @param channelID 渠道名称, 为nil或@""时, 默认为@"AppStore"渠道
  28. @return void.
  29. */
  30. + (void)setChannelID:(NSString*)channelID;
  31. /** 设定日志上传的发送间隔
  32. @param frequecy 单位为秒,最小30秒,最大8*60*60秒(8小时)。默认为180秒(3分钟)
  33. @return void.
  34. */
  35. + (void)setUploadFrequecy:(NSTimeInterval)frequecy;
  36. #pragma mark - Statistics Api
  37. /** 自动页面时长统计, 开始记录某个页面展示时长.
  38. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。
  39. 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:
  40. @param pageName 统计的页面名称.
  41. @return void.
  42. */
  43. + (void)beginLogPageView:(NSString *)pageName;
  44. /** 自动页面时长统计, 结束记录某个页面展示时长.
  45. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。
  46. 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:
  47. @param pageName 统计的页面名称.
  48. @return void.
  49. */
  50. + (void)endLogPageView:(NSString *)pageName;
  51. /** 自动事件时长统计, 开始记录某个事示时长.
  52. 使用方法:调用event:函数来完成自动统计。
  53. @param eventID 统计的事件标识符.
  54. @warning eventID不能使用空格和特殊字符,且长度不能超过255个字符(否则将截取前255个字符)
  55. */
  56. + (void)event:(NSString *)eventID;
  57. /** 自动事件时长统计, 开始记录某个事示时长.
  58. 使用方法:调用event:函数来完成自动统计。
  59. @param eventID 统计的事件标识符.
  60. @param pageName 事件发生时所在页面.
  61. @param userInfo 事件相关信息.
  62. @return void.
  63. @warning 每个event的userInfo不能超过10个
  64. eventID、pageName、userInfo中key和value都不能使用空格和特殊字符,且长度不能超过255个字符(否则将截取前255个字符)
  65. */
  66. + (void)event:(NSString *)eventID onPageView:(NSString*)pageName withUserInfo:(NSDictionary*)userInfo;
  67. /** 强制日志上传
  68. 调用后,若距离上次成功上传日志时间不小于30秒,立刻上传日志。
  69. */
  70. + (void)forceUploadRecords;
  71. @end