MobClick Class Reference

Inherits from NSObject
Conforms to UIAlertViewDelegate
Declared in MobClick.h

初始化统计

+ startWithConfigure:

初始化友盟统计模块

+ (void)startWithConfigure:(UMAnalyticsConfig *)configure

Parameters

UMAnalyticsConfig

实例类,具体参照该类成员的参数定义

Return Value

void

Discussion

初始化友盟统计模块

Declared In

MobClick.h

设置

+ setAppVersion:

设置app版本号。由于历史原因需要和xcode3工程兼容,友盟提取的是Build号(CFBundleVersion), 如果需要和App Store上的版本一致,请调用此方法。

+ (void)setAppVersion:(NSString *)appVersion

Parameters

appVersion

版本号,例如设置成XcodeAppVersion.

Return Value

void.

Discussion

设置app版本号。由于历史原因需要和xcode3工程兼容,友盟提取的是Build号(CFBundleVersion), 如果需要和App Store上的版本一致,请调用此方法。

Declared In

MobClick.h

+ setCrashReportEnabled:

开启CrashReport收集, 默认YES(开启状态).

+ (void)setCrashReportEnabled:(BOOL)value

Parameters

value

设置为NO,可关闭友盟CrashReport收集功能.

Return Value

void.

Discussion

开启CrashReport收集, 默认YES(开启状态).

Declared In

MobClick.h

+ setLogEnabled:

设置是否打印sdk的log信息, 默认NO(不打印log).

+ (void)setLogEnabled:(BOOL)value

Parameters

value

设置为YES,umeng SDK 会输出log信息可供调试参考. 除非特殊需要,否则发布产品时需改回NO.

Return Value

void.

Discussion

设置是否打印sdk的log信息, 默认NO(不打印log).

Declared In

MobClick.h

+ setBackgroundTaskEnabled:

设置是否开启background模式, 默认YES.

+ (void)setBackgroundTaskEnabled:(BOOL)value

Parameters

value

为YES,SDK会确保在app进入后台的短暂时间保存日志信息的完整性,对于已支持background模式和一般app不会有影响. 如果该模式影响某些App在切换到后台的功能,也可将该值设置为NO.

Return Value

void.

Discussion

设置是否开启background模式, 默认YES.

Declared In

MobClick.h

+ setEncryptEnabled:

设置是否对日志信息进行加密, 默认NO(不加密).

+ (void)setEncryptEnabled:(BOOL)value

Parameters

value

设置为YES, umeng SDK 会将日志信息做加密处理

Return Value

void.

Discussion

设置是否对日志信息进行加密, 默认NO(不加密).

Declared In

MobClick.h

+ setLogSendInterval:

当reportPolicy == SEND_INTERVAL 时设定log发送间隔

+ (void)setLogSendInterval:(double)second

Parameters

second

单位为秒,最小90秒,最大86400秒(24hour).

Return Value

void.

Discussion

当reportPolicy == SEND_INTERVAL 时设定log发送间隔

Declared In

MobClick.h

+ setLatency:

设置日志延迟发送

+ (void)setLatency:(int)second

Parameters

second

设置一个[0, second]范围的延迟发送秒数,最大值1800s.

Return Value

void

Discussion

设置日志延迟发送

Declared In

MobClick.h

页面计时

+ logPageView:seconds:

手动页面时长统计, 记录某个页面展示的时长.

+ (void)logPageView:(NSString *)pageName seconds:(int)seconds

Parameters

pageName

统计的页面名称.

seconds

单位为秒,int型.

Return Value

void.

Discussion

手动页面时长统计, 记录某个页面展示的时长.

Declared In

MobClick.h

+ beginLogPageView:

自动页面时长统计, 开始记录某个页面展示时长. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:

+ (void)beginLogPageView:(NSString *)pageName

Parameters

pageName

统计的页面名称.

Return Value

void.

Discussion

自动页面时长统计, 开始记录某个页面展示时长. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:

Declared In

MobClick.h

+ endLogPageView:

自动页面时长统计, 结束记录某个页面展示时长. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:

+ (void)endLogPageView:(NSString *)pageName

Parameters

pageName

统计的页面名称.

Return Value

void.

Discussion

自动页面时长统计, 结束记录某个页面展示时长. 使用方法:必须配对调用beginLogPageView:和endLogPageView:两个函数来完成自动统计,若只调用某一个函数不会生成有效数据。 在该页面展示时调用beginLogPageView:,当退出该页面时调用endLogPageView:

Declared In

MobClick.h

事件统计

+ event:value:label:

结构化事件 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID。

+ (void)event:(NSArray *)keyPath value:(int)value label:(NSString *)label

Parameters

keyPath

字符串数组代表的结构化事件路径,其长度最大为8,不能使用unicode 48以内的字符,keyPath[0]必须在网站注册事件ID.

value

事件的数值

(optional)

label 标签

Return Value

void.

Discussion

结构化事件 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID。

Declared In

MobClick.h

+ event:

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

+ (void)event:(NSString *)eventId

Parameters

eventId

网站上注册的事件Id.

label

分类标签。不同的标签会分别进行统计,方便同一事件的不同标签的对比,为nil或空字符串时后台会生成和eventId同名的标签.

accumulation

累加值。为减少网络交互,可以自行对某一事件ID的某一分类标签进行累加,再传入次数作为参数。

Return Value

void.

Discussion

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

Declared In

MobClick.h

+ event:label:

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

+ (void)event:(NSString *)eventId label:(NSString *)label

Discussion

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

Declared In

MobClick.h

+ event:attributes:

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

+ (void)event:(NSString *)eventId attributes:(NSDictionary *)attributes

Discussion

自定义事件,数量统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID

Declared In

MobClick.h

+ beginEvent:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID. beginEvent,endEvent要配对使用,也可以自己计时后通过durations参数传递进来

+ (void)beginEvent:(NSString *)eventId

Parameters

eventId

网站上注册的事件Id.

label

分类标签。不同的标签会分别进行统计,方便同一事件的不同标签的对比,为nil或空字符串时后台会生成和eventId同名的标签.

primarykey

这个参数用于和event_id一起标示一个唯一事件,并不会被统计;对于同一个事件在beginEvent和endEvent 中要传递相同的eventId 和 primarykey

millisecond

自己计时需要的话需要传毫秒进来

Return Value

void.

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID. beginEvent,endEvent要配对使用,也可以自己计时后通过durations参数传递进来

Warning: 每个event的attributes不能超过10个 eventId、attributes中key和value都不能使用空格和特殊字符,且长度不能超过255个字符(否则将截取前255个字符) id, ts, du是保留字段,不能作为eventId及key的名称

Declared In

MobClick.h

+ endEvent:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)endEvent:(NSString *)eventId

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ beginEvent:label:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)beginEvent:(NSString *)eventId label:(NSString *)label

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ endEvent:label:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)endEvent:(NSString *)eventId label:(NSString *)label

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ beginEvent:primarykey:attributes:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)beginEvent:(NSString *)eventId primarykey:(NSString *)keyName attributes:(NSDictionary *)attributes

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ endEvent:primarykey:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)endEvent:(NSString *)eventId primarykey:(NSString *)keyName

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ event:durations:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)event:(NSString *)eventId durations:(int)millisecond

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ event:label:durations:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)event:(NSString *)eventId label:(NSString *)label durations:(int)millisecond

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ event:attributes:durations:

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

+ (void)event:(NSString *)eventId attributes:(NSDictionary *)attributes durations:(int)millisecond

Discussion

自定义事件,时长统计. 使用前,请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID,然后在工程中传入相应的事件ID.

Declared In

MobClick.h

+ profileSignInWithPUID:

active user sign-in. 使用sign-In函数后,如果结束该PUID的统计,需要调用sign-Off函数

+ (void)profileSignInWithPUID:(NSString *)puid

Parameters

puid

: user’s ID

provider

: 不能以下划线"_“开头,使用大写字母和数字标识; 如果是上市公司,建议使用股票代码。

Return Value

void.

Discussion

active user sign-in. 使用sign-In函数后,如果结束该PUID的统计,需要调用sign-Off函数

Declared In

MobClick.h

+ profileSignOff

active user sign-off. 停止sign-in PUID的统计

+ (void)profileSignOff

Return Value

void.

Discussion

active user sign-off. 停止sign-in PUID的统计

Declared In

MobClick.h

地理位置设置

+ setLatitude:longitude:

设置经纬度信息

+ (void)setLatitude:(double)latitude longitude:(double)longitude

Parameters

latitude

纬度.

longitude

经度.

Return Value

void

Discussion

设置经纬度信息

Declared In

MobClick.h

+ setLocation:

设置经纬度信息

+ (void)setLocation:(CLLocation *)location

Parameters

location

CLLocation 经纬度信息

Return Value

void

Discussion

设置经纬度信息

Declared In

MobClick.h

Utility函数

+ isJailbroken

判断设备是否越狱,依据是否存在apt和Cydia.app

+ (BOOL)isJailbroken

Discussion

判断设备是否越狱,依据是否存在apt和Cydia.app

Declared In

MobClick.h

+ isPirated

判断App是否被破解

+ (BOOL)isPirated

Discussion

判断App是否被破解

Declared In

MobClick.h

+ startSession:

友盟模块启动 [MobClick startWithConfigure:]通常在application:didFinishLaunchingWithOptions:里被调用监听App启动和退出事件, 如果开发者无法在此处添加友盟的[MobClick startWithConfigure:]方法,App的启动事件可能会无法监听,此时需要手动调用[MobClick startSession:nil]来启动友盟的session。 上述情况通常发生在某些第三方框架生成的app里,普通app不用关注该API.

+ (void)startSession:(NSNotification *)notification

Discussion

友盟模块启动 [MobClick startWithConfigure:]通常在application:didFinishLaunchingWithOptions:里被调用监听App启动和退出事件, 如果开发者无法在此处添加友盟的[MobClick startWithConfigure:]方法,App的启动事件可能会无法监听,此时需要手动调用[MobClick startSession:nil]来启动友盟的session。 上述情况通常发生在某些第三方框架生成的app里,普通app不用关注该API.

Declared In

MobClick.h