MobClick.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. //
  2. // MobClick.h
  3. // Analytics
  4. //
  5. // Copyright (C) 2010-2017 Umeng.com . All rights reserved.
  6. #import <UIKit/UIKit.h>
  7. #import <Foundation/Foundation.h>
  8. typedef void(^CallbackBlock)();
  9. @class CLLocation;
  10. @interface MobClick : NSObject <UIAlertViewDelegate>
  11. #pragma mark basics
  12. ///---------------------------------------------------------------------------------------
  13. /// @name 设置
  14. ///---------------------------------------------------------------------------------------
  15. /** 开启CrashReport收集, 默认YES(开启状态).
  16. @param value 设置为NO,可关闭友盟CrashReport收集功能.
  17. @return void.
  18. */
  19. + (void)setCrashReportEnabled:(BOOL)value;
  20. #pragma mark event logs
  21. ///---------------------------------------------------------------------------------------
  22. /// @name 页面计时
  23. ///---------------------------------------------------------------------------------------
  24. /** 手动页面时长统计, 记录某个页面展示的时长.
  25. @param pageName 统计的页面名称.
  26. @param seconds 单位为秒,int型.
  27. @return void.
  28. */
  29. + (void)logPageView:(NSString *)pageName seconds:(int)seconds;
  30. /** 自动页面时长统计, 开始记录某个页面展示时长.
  31. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。
  32. 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:
  33. @param pageName 统计的页面名称.
  34. @return void.
  35. */
  36. + (void)beginLogPageView:(NSString *)pageName;
  37. /** 自动页面时长统计, 结束记录某个页面展示时长.
  38. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。
  39. 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:
  40. @param pageName 统计的页面名称.
  41. @return void.
  42. */
  43. + (void)endLogPageView:(NSString *)pageName;
  44. ///---------------------------------------------------------------------------------------
  45. /// @name 事件统计
  46. ///---------------------------------------------------------------------------------------
  47. /** 自定义事件,数量统计.
  48. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID
  49. @param eventId 网站上注册的事件Id.
  50. @param label 分类标签。不同的标签会分别进行统计,方便同一事件的不同标签的对比,为nil或空字符串时后台会生成和eventId同名的标签.
  51. @param accumulation 累加值。为减少网络交互,可以自行对某一事件ID的某一分类标签进行累加,再传入次数作为参数。
  52. @return void.
  53. */
  54. + (void)event:(NSString *)eventId; //等同于 event:eventId label:eventId;
  55. /** 自定义事件,数量统计.
  56. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID
  57. */
  58. + (void)event:(NSString *)eventId label:(NSString *)label; // label为nil或@""时,等同于 event:eventId label:eventId;
  59. /** 自定义事件,数量统计.
  60. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID
  61. */
  62. + (void)event:(NSString *)eventId attributes:(NSDictionary *)attributes;
  63. + (void)event:(NSString *)eventId attributes:(NSDictionary *)attributes counter:(int)number;
  64. /** 自定义事件,时长统计.
  65. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  66. beginEvent,endEvent要配对使用,也可以自己计时后通过durations参数传递进来
  67. @param eventId 网站上注册的事件Id.
  68. @param label 分类标签。不同的标签会分别进行统计,方便同一事件的不同标签的对比,为nil或空字符串时后台会生成和eventId同名的标签.
  69. @param primarykey 这个参数用于和event_id一起标示一个唯一事件,并不会被统计;对于同一个事件在beginEvent和endEvent 中要传递相同的eventId 和 primarykey
  70. @param millisecond 自己计时需要的话需要传毫秒进来
  71. @return void.
  72. @warning 每个event的attributes不能超过10个
  73. eventId、attributes中key和value都不能使用空格和特殊字符,必须是NSString,且长度不能超过255个字符(否则将截取前255个字符)
  74. id, ts, du是保留字段,不能作为eventId及key的名称
  75. */
  76. + (void)beginEvent:(NSString *)eventId;
  77. /** 自定义事件,时长统计.
  78. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  79. */
  80. + (void)endEvent:(NSString *)eventId;
  81. /** 自定义事件,时长统计.
  82. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  83. */
  84. + (void)beginEvent:(NSString *)eventId label:(NSString *)label;
  85. /** 自定义事件,时长统计.
  86. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  87. */
  88. + (void)endEvent:(NSString *)eventId label:(NSString *)label;
  89. /** 自定义事件,时长统计.
  90. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  91. */
  92. + (void)beginEvent:(NSString *)eventId primarykey :(NSString *)keyName attributes:(NSDictionary *)attributes;
  93. /** 自定义事件,时长统计.
  94. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  95. */
  96. + (void)endEvent:(NSString *)eventId primarykey:(NSString *)keyName;
  97. /** 自定义事件,时长统计.
  98. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  99. */
  100. + (void)event:(NSString *)eventId durations:(int)millisecond;
  101. /** 自定义事件,时长统计.
  102. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  103. */
  104. + (void)event:(NSString *)eventId label:(NSString *)label durations:(int)millisecond;
  105. /** 自定义事件,时长统计.
  106. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.
  107. */
  108. + (void)event:(NSString *)eventId attributes:(NSDictionary *)attributes durations:(int)millisecond;
  109. #pragma mark - user methods
  110. /** active user sign-in.
  111. 使用sign-In函数后,如果结束该PUID的统计,需要调用sign-Off函数
  112. @param puid : user's ID
  113. @param provider : 不能以下划线"_"开头,使用大写字母和数字标识; 如果是上市公司,建议使用股票代码。
  114. @return void.
  115. */
  116. + (void)profileSignInWithPUID:(NSString *)puid;
  117. + (void)profileSignInWithPUID:(NSString *)puid provider:(NSString *)provider;
  118. /** active user sign-off.
  119. 停止sign-in PUID的统计
  120. @return void.
  121. */
  122. + (void)profileSignOff;
  123. ///---------------------------------------------------------------------------------------
  124. /// @name 地理位置设置
  125. /// 需要链接 CoreLocation.framework 并且 #import <CoreLocation/CoreLocation.h>
  126. ///---------------------------------------------------------------------------------------
  127. /** 设置经纬度信息
  128. @param latitude 纬度.
  129. @param longitude 经度.
  130. @return void
  131. */
  132. + (void)setLatitude:(double)latitude longitude:(double)longitude;
  133. /** 设置经纬度信息
  134. @param location CLLocation 经纬度信息
  135. @return void
  136. */
  137. + (void)setLocation:(CLLocation *)location;
  138. ///---------------------------------------------------------------------------------------
  139. /// @name Utility函数
  140. ///---------------------------------------------------------------------------------------
  141. /** 判断设备是否越狱,依据是否存在apt和Cydia.app
  142. */
  143. + (BOOL)isJailbroken;
  144. /** 判断App是否被破解
  145. */
  146. + (BOOL)isPirated;
  147. /** 设置 app secret
  148. @param secret string
  149. @return void.
  150. */
  151. + (void)setSecret:(NSString *)secret;
  152. + (void)setCrashCBBlock:(CallbackBlock)cbBlock;
  153. /** DeepLink事件
  154. @param link 唤起应用的link
  155. @return void.
  156. */
  157. + (void)onDeepLinkReceived:(NSURL *)link;
  158. /**
  159. * 设置预置事件属性 键值对 会覆盖同名的key
  160. */
  161. +(void) registerPreProperties:(NSDictionary *)property;
  162. /**
  163. *
  164. * 删除指定预置事件属性
  165. @param key
  166. */
  167. +(void) unregisterPreProperty:(NSString *)propertyName;
  168. /**
  169. * 获取预置事件所有属性;如果不存在,则返回空。
  170. */
  171. +(NSDictionary *)getPreProperties;
  172. /**
  173. *清空所有预置事件属性。
  174. */
  175. +(void)clearPreProperties;
  176. /**
  177. * 设置关注事件是否首次触发,只关注eventList前五个合法eventID.只要已经保存五个,此接口无效
  178. */
  179. +(void)setFirstLaunchEvent:(NSArray *)eventList;
  180. /** 设置是否自动采集页面, 默认NO(不自动采集).
  181. @param value 设置为YES, umeng SDK 会将自动采集页面信息
  182. */
  183. + (void)setAutoPageEnabled:(BOOL)value;
  184. @end