ISensorsDataAPI (module_common 0.3.8 API)

所有超级接口:

AutoTrackProtocol, IFragmentAPI, IUserIdentityAPI, SAAdvertAPIProtocol, SAExposureAPIProtocol

所有已知实现类:

SensorsDataAPI, SensorsDataAPIEmptyImplementation
```
public interface ISensorsDataAPI
extends IUserIdentityAPI, SAAdvertAPIProtocol, AutoTrackProtocol, SAExposureAPIProtocol
```

字段概要
- 从接口继承的字段 com.sensorsdata.analytics.android.sdk.useridentity.IUserIdentityAPI
  BIND_ID, UNBIND_ID

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`void`	`addHeatMapActivities(java.util.List<java.lang.Class<?>> activitiesList)` 开启多个 activity 的点击图
`void`	`addHeatMapActivity(java.lang.Class<?> activity)` 开启某个 activity 的点击图
`void`	`addVisualizedAutoTrackActivities(java.util.List<java.lang.Class<?>> activitiesList)` 开启多个 activity 的可视化全埋点
`void`	`addVisualizedAutoTrackActivity(java.lang.Class<?> activity)` 开启某个 activity 的可视化全埋点
`void`	`clearGPSLocation()` 清除 GPS 位置信息
`void`	`clearSuperProperties()` 删除所有事件公共属性
`void`	`clearTrackTimer()` 清除所有事件计时器
`void`	`deleteAll()` 删除本地缓存的全部事件
`void`	`enableDeepLinkInstallSource(boolean enable)` DeepLink 是否采集设备信息
`void`	`enableLog(boolean enable)` 设置是否开启 log
`void`	`enableNetworkRequest(boolean isRequest)` 设置是否允许请求网络，默认是 true
`void`	`enableRemoteConfig(boolean enable)` 是否开启远程配置
`void`	`enableTrackScreenOrientation(boolean enable)` 开启/关闭采集屏幕方向
`void`	`flush()` 将所有本地缓存的日志发送到 Sensors Analytics.
`void`	`flushScheduled()` 以轮询形式将所有本地缓存的日志发送到 Sensors Analytics.
`void`	`flushSync()` 将所有本地缓存的日志发送到 Sensors Analytics.
`java.lang.String`	`getAnonymousId()` 获取当前用户的匿名 ID 若调用前未调用 `identify(String)` 设置用户的匿名 ID，SDK 会优先调用 SensorsDataUtils#getAndroidID 获取 Android ID，如获取的 Android ID 非法，则调用 `UUID` 随机生成 UUID，作为用户的匿名 ID
`java.lang.String`	`getCookie(boolean decode)` 获取已设置的 Cookie URLDecoder.decode(Cookie, "UTF-8")
`java.lang.String`	`getDistinctId()` 获取当前用户的 distinctId
`int`	`getFlushBulkSize()` 返回本地缓存日志的最大条目数默认值为 100 条在每次调用 track、signUp 以及 profileSet 等接口的时候，都会检查如下条件，以判断是否向服务器上传数据: 1.
`int`	`getFlushInterval()` 两次数据发送的最小时间间隔，单位毫秒默认值为 15 * 1000 毫秒在每次调用 track、signUp 以及 profileSet 等接口的时候，都会检查如下条件，以判断是否向服务器上传数据: 1.
`java.lang.String`	`getLoginId()` 获取当前用户的 loginId 若调用前未调用 `login(String)` 设置用户的 loginId，会返回 null
`long`	`getMaxCacheSize()` 获取本地缓存上限制
`org.json.JSONObject`	`getPresetProperties()` 返回预置属性
`java.lang.String`	`getScreenOrientation()` 获取当前屏幕方向
`java.lang.String`	`getServerUrl()` 获取当前 serverUrl
`int`	`getSessionIntervalTime()` 设置 App 切换到后台与下次事件的事件间隔默认值为 30*1000 毫秒若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件
`org.json.JSONObject`	`getSuperProperties()` 获取事件公共属性
`void`	`identify(java.lang.String distinctId)` 设置当前用户的 distinctId。
`boolean`	`isDebugMode()` 是否是开启 debug 模式
`boolean`	`isHeatMapActivity(java.lang.Class<?> activity)` activity 是否开启了点击图
`boolean`	`isHeatMapEnabled()` 是否开启点击图
`boolean`	`isNetworkRequestEnable()` 是否请求网络，默认是 true
`boolean`	`isVisualizedAutoTrackActivity(java.lang.Class<?> activity)` activity 是否开启了可视化全埋点
`boolean`	`isVisualizedAutoTrackEnabled()` 是否开启可视化全埋点
`void`	`itemDelete(java.lang.String itemType, java.lang.String itemId)` 删除 item
`void`	`itemSet(java.lang.String itemType, java.lang.String itemId, org.json.JSONObject properties)` 设置 item
`void`	`login(java.lang.String loginId)` 登录，设置当前用户的 loginId
`void`	`login(java.lang.String loginId, org.json.JSONObject properties)` 登录，设置当前用户的 loginId
`void`	`logout()` 注销，清空当前用户的 loginId
`void`	`profileAppend(java.lang.String property, java.util.Set<java.lang.String> values)` 给一个列表类型的 Profile 增加一个或多个元素
`void`	`profileAppend(java.lang.String property, java.lang.String value)` 给一个列表类型的 Profile 增加一个元素
`void`	`profileDelete()` 删除用户所有 Profile
`void`	`profileIncrement(java.util.Map<java.lang.String,? extends java.lang.Number> properties)` 给一个或多个数值类型的 Profile 增加一个数值。
`void`	`profileIncrement(java.lang.String property, java.lang.Number value)` 给一个数值类型的 Profile 增加一个数值。
`void`	`profilePushId(java.lang.String pushTypeKey, java.lang.String pushId)` 保存用户推送 ID 到用户表
`void`	`profileSet(org.json.JSONObject properties)` 设置用户的一个或多个 Profile。
`void`	`profileSet(java.lang.String property, java.lang.Object value)` 设置用户的一个 Profile，如果之前存在，则覆盖，否则，新创建
`void`	`profileSetOnce(org.json.JSONObject properties)` 首次设置用户的一个或多个 Profile。
`void`	`profileSetOnce(java.lang.String property, java.lang.Object value)` 首次设置用户的一个 Profile 与profileSet接口不同的是，如果之前存在，则忽略，否则，新创建
`void`	`profileUnset(java.lang.String property)` 删除用户的一个 Profile
`void`	`profileUnsetPushId(java.lang.String pushTypeKey)` 删除用户设置的 pushId
`void`	`registerDynamicSuperProperties(SensorsDataDynamicSuperProperties dynamicSuperProperties)` 注册事件动态公共属性
`void`	`registerLimitKeys(java.util.Map<java.lang.String,java.lang.String> limitKeys)` 注册限制性属性 key
`void`	`registerPropertyPlugin(SAPropertyPlugin plugin)` 注册自定义插件
`void`	`registerSuperProperties(org.json.JSONObject superProperties)` 注册所有事件都有的公共属性
`void`	`removeTimer(java.lang.String eventName)` 删除事件的计时器
`void`	`resetAnonymousId()` 已过时。
`void`	`resumeTrackScreenOrientation()` 恢复采集屏幕方向
`void`	`setCookie(java.lang.String cookie, boolean encode)` 设置 Cookie，flush 的时候会设置 HTTP 的 cookie 内部会 URLEncoder.encode(cookie, "UTF-8")
`void`	`setFlushBulkSize(int flushBulkSize)` 设置本地缓存日志的最大条目数，最小 50 条
`void`	`setFlushInterval(int flushInterval)` 设置两次数据发送的最小时间间隔
`void`	`setFlushNetworkPolicy(int networkType)` 设置 flush 时网络发送策略，默认 3G、4G、5G、WI-FI 环境下都会尝试 flush
`void`	`setGPSLocation(double latitude, double longitude)` 更新 GPS 位置信息
`void`	`setGPSLocation(double latitude, double longitude, java.lang.String coordinate)` 更新 GPS 位置信息及对应坐标系
`void`	`setMaxCacheSize(long maxCacheSize)` 设置本地缓存上限值，单位 byte，默认为 32MB：32 * 1024 * 1024，最小 16MB：16 * 1024 * 1024，若小于 16MB，则按 16MB 处理。
`void`	`setServerUrl(java.lang.String serverUrl)` 设置当前 serverUrl
`void`	`setServerUrl(java.lang.String serverUrl, boolean isRequestRemoteConfig)` 设置当前 serverUrl
`void`	`setSessionIntervalTime(int sessionIntervalTime)` 设置 App 切换到后台与下次事件的事件间隔默认值为 30*1000 毫秒若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件
`void`	`setTrackEventCallBack(SensorsDataTrackEventCallBack trackEventCallBack)` 设置 track 事件回调
`void`	`showUpWebView(android.webkit.WebView webView, boolean isSupportJellyBean)` 向 WebView 注入本地方法，默认不开启认证校验。
`void`	`showUpWebView(android.webkit.WebView webView, boolean isSupportJellyBean, boolean enableVerify)` 向 WebView 注入本地方法
`void`	`showUpWebView(android.webkit.WebView webView, boolean isSupportJellyBean, org.json.JSONObject properties)` 已过时。
`void`	`showUpWebView(android.webkit.WebView webView, org.json.JSONObject properties, boolean isSupportJellyBean, boolean enableVerify)` 已过时。
`void`	`showUpX5WebView(java.lang.Object x5WebView)` 向腾讯 x5WebView 注入本地方法, 默认不开启认证校验。
`void`	`showUpX5WebView(java.lang.Object x5WebView, boolean enableVerify)` 向腾讯 x5WebView 注入本地方法
`void`	`showUpX5WebView(java.lang.Object x5WebView, org.json.JSONObject properties, boolean isSupportJellyBean, boolean enableVerify)` 已过时。
`void`	`startTrackThread()` 开启事件采集
`void`	`stopTrackScreenOrientation()` 暂停采集屏幕方向
`void`	`stopTrackThread()` 停止事件采集，注意不要随便调用，调用后会造成数据丢失。
`void`	`track(java.lang.String eventName)` 与 `track(String, JSONObject)` 类似，无事件属性
`void`	`track(java.lang.String eventName, org.json.JSONObject properties)`
`void`	`trackDeepLinkLaunch(java.lang.String deepLinkUrl)` 记录 $AppDeepLinkLaunch `trackDeepLinkLaunch(String, String)`}事件
`void`	`trackDeepLinkLaunch(java.lang.String deepLinkUrl, java.lang.String oaid)` 记录 $AppDeepLinkLaunch 事件
`void`	`trackTimer(java.lang.String eventName, java.util.concurrent.TimeUnit timeUnit)` 已过时。
`void`	`trackTimerEnd(java.lang.String eventName)` 停止事件计时器
`void`	`trackTimerEnd(java.lang.String eventName, org.json.JSONObject properties)` 停止事件计时器
`void`	`trackTimerPause(java.lang.String eventName)` 暂停事件计时器，计时单位为秒。
`void`	`trackTimerResume(java.lang.String eventName)` 恢复事件计时器，计时单位为秒。
`java.lang.String`	`trackTimerStart(java.lang.String eventName)` 初始化事件的计时器，计时单位为秒。
`void`	`unregisterPropertyPlugin(SAPropertyPlugin plugin)` 注销自定义插件
`void`	`unregisterSuperProperty(java.lang.String superPropertyName)` 删除事件公共属性

从接口继承的方法 com.sensorsdata.analytics.android.sdk.useridentity.IUserIdentityAPI
bind, getIdentities, loginWithKey, loginWithKey, resetAnonymousIdentity, unbind

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.advert.SAAdvertAPIProtocol
requestDeferredDeepLink, setDeepLinkCallback, setDeepLinkCompletion, trackAppInstall, trackAppInstall, trackAppInstall, trackChannelEvent, trackChannelEvent, trackInstallation, trackInstallation, trackInstallation

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.autotrack.IFragmentAPI
enableAutoTrackFragment, enableAutoTrackFragments, ignoreAutoTrackFragment, ignoreAutoTrackFragments, isFragmentAutoTrackAppViewScreen, isTrackFragmentAppViewScreenEnabled, resumeIgnoredAutoTrackFragment, resumeIgnoredAutoTrackFragments, trackFragmentAppViewScreen

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.exposure.SAExposureAPIProtocol
addExposureView, removeExposureView, removeExposureView, setExposureIdentifier, updateExposureProperties

- 方法详细资料
  - getPresetProperties
```
org.json.JSONObject getPresetProperties()
```
    返回预置属性
    
    返回:
    
    JSONObject 预置属性
  - getServerUrl
```
java.lang.String getServerUrl()
```
    获取当前 serverUrl
    
    返回:
    
    当前 serverUrl
  - setServerUrl
```
void setServerUrl(java.lang.String serverUrl)
```
    设置当前 serverUrl
    
    参数:
    
    serverUrl - 当前 serverUrl
  - setServerUrl
```
void setServerUrl(java.lang.String serverUrl,
                  boolean isRequestRemoteConfig)
```
    设置当前 serverUrl
    
    参数:
    
    serverUrl - 当前 serverUrl
    
    isRequestRemoteConfig - 是否立即请求当前 serverUrl 的远程配置
  - enableLog
```
void enableLog(boolean enable)
```
    设置是否开启 log
    
    参数:
    
    enable - boolean
  - getMaxCacheSize
```
long getMaxCacheSize()
```
    获取本地缓存上限制
    
    返回:
    
    字节
  - setMaxCacheSize
```
void setMaxCacheSize(long maxCacheSize)
```
    设置本地缓存上限值，单位 byte，默认为 32MB：32 * 1024 * 1024，最小 16MB：16 * 1024 * 1024，若小于 16MB，则按 16MB 处理。
    
    参数:
    
    maxCacheSize - 单位 byte
  - isDebugMode
```
boolean isDebugMode()
```
    是否是开启 debug 模式
    
    返回:
    
    true：是，false：不是
  - isNetworkRequestEnable
```
boolean isNetworkRequestEnable()
```
    是否请求网络，默认是 true
    
    返回:
    
    是否请求网络
  - enableNetworkRequest
```
void enableNetworkRequest(boolean isRequest)
```
    设置是否允许请求网络，默认是 true
    
    参数:
    
    isRequest - boolean
  - setFlushNetworkPolicy
```
void setFlushNetworkPolicy(int networkType)
```
    设置 flush 时网络发送策略，默认 3G、4G、5G、WI-FI 环境下都会尝试 flush
    
    参数:
    
    networkType - int 网络类型
  - getFlushInterval
```
int getFlushInterval()
```
    两次数据发送的最小时间间隔，单位毫秒默认值为 15 * 1000 毫秒在每次调用 track、signUp 以及 profileSet 等接口的时候，都会检查如下条件，以判断是否向服务器上传数据: 1. 是否是 WIFI/3G/4G 网络条件 2. 是否满足发送条件之一: 1) 与上次发送的时间间隔是否大于 flushInterval 2) 本地缓存日志数目是否大于 flushBulkSize 如果满足这两个条件，则向服务器发送一次数据；如果不满足，则把数据加入到队列中，等待下次检查时把整个队列的内容一并发送。需要注意的是，为了避免占用过多存储，队列最多只缓存 20MB 数据。
    
    返回:
    
    返回时间间隔，单位毫秒
  - setFlushInterval
```
void setFlushInterval(int flushInterval)
```
    设置两次数据发送的最小时间间隔
    
    参数:
    
    flushInterval - 时间间隔，单位毫秒
  - getFlushBulkSize
```
int getFlushBulkSize()
```
    返回本地缓存日志的最大条目数默认值为 100 条在每次调用 track、signUp 以及 profileSet 等接口的时候，都会检查如下条件，以判断是否向服务器上传数据: 1. 是否是 WIFI/3G/4G 网络条件 2. 是否满足发送条件之一: 1) 与上次发送的时间间隔是否大于 flushInterval 2) 本地缓存日志数目是否大于 flushBulkSize 如果满足这两个条件，则向服务器发送一次数据；如果不满足，则把数据加入到队列中，等待下次检查时把整个队列的内容一并发送。需要注意的是，为了避免占用过多存储，队列最多只缓存 32MB 数据。
    
    返回:
    
    返回本地缓存日志的最大条目数
  - setFlushBulkSize
```
void setFlushBulkSize(int flushBulkSize)
```
    设置本地缓存日志的最大条目数，最小 50 条
    
    参数:
    
    flushBulkSize - 缓存数目
  - getSessionIntervalTime
```
int getSessionIntervalTime()
```
    设置 App 切换到后台与下次事件的事件间隔默认值为 30*1000 毫秒若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件
    
    返回:
    
    返回设置的 SessionIntervalTime ，默认是 30s
  - setSessionIntervalTime
```
void setSessionIntervalTime(int sessionIntervalTime)
```
    设置 App 切换到后台与下次事件的事件间隔默认值为 30*1000 毫秒若 App 在后台超过设定事件，则认为当前 Session 结束，发送 $AppEnd 事件
    
    参数:
    
    sessionIntervalTime - int
  - showUpWebView
```
void showUpWebView(android.webkit.WebView webView,
                   boolean isSupportJellyBean)
```
    向 WebView 注入本地方法，默认不开启认证校验。
    
    参数:
    
    webView - 当前 WebView
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。因为 API level 16 及以下的版本, addJavascriptInterface 有安全漏洞,请谨慎使用
  - showUpWebView
```
void showUpWebView(android.webkit.WebView webView,
                   boolean isSupportJellyBean,
                   boolean enableVerify)
```
    向 WebView 注入本地方法
    
    参数:
    
    webView - 当前 WebView
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。
    
    enableVerify - 是否开启认证因为 API level 16 及以下的版本, addJavascriptInterface 有安全漏洞,请谨慎使用
  - showUpWebView
```
@Deprecated
void showUpWebView(android.webkit.WebView webView,
                               org.json.JSONObject properties,
                               boolean isSupportJellyBean,
                               boolean enableVerify)
```
    已过时。
    
    向 WebView 注入本地方法, 将 distinctId 传递给当前的 WebView，该方法用于老版打通方式，已过时。
    
    参数:
    
    webView - 当前 WebView
    
    properties - 属性
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。
    
    enableVerify - 是否开启认证因为 API level 16 及以下的版本, addJavascriptInterface 有安全漏洞,请谨慎使用。此方法谨慎修改，插件配置 disableJsInterface 会修改此方法。
  - showUpWebView
```
@Deprecated
void showUpWebView(android.webkit.WebView webView,
                               boolean isSupportJellyBean,
                               org.json.JSONObject properties)
```
    已过时。
    
    向 WebView 注入本地方法, 将 distinctId 传递给当前的 WebView，该方法用于老版打通方式，已过时。
    
    参数:
    
    webView - 当前 WebView
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。因为 API level 16 及以下的版本, addJavascriptInterface 有安全漏洞,请谨慎使用
    
    properties - 用户自定义属性
  - showUpX5WebView
```
@Deprecated
void showUpX5WebView(java.lang.Object x5WebView,
                                 org.json.JSONObject properties,
                                 boolean isSupportJellyBean,
                                 boolean enableVerify)
```
    已过时。
    
    向腾讯 x5WebView 注入本地方法, 将 distinctId 传递给当前的 WebView，该方法用于老版打通方式，已过时。
    
    参数:
    
    x5WebView - 腾讯 x5WebView
    
    properties - 属性
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。
    
    enableVerify - 是否开启认证此方法谨慎修改，插件配置 disableJsInterface 会修改此方法。
  - showUpX5WebView
```
void showUpX5WebView(java.lang.Object x5WebView,
                     boolean enableVerify)
```
    向腾讯 x5WebView 注入本地方法
    
    参数:
    
    x5WebView - 腾讯 x5WebView
    
    enableVerify - 是否开启认证此方法谨慎修改，插件配置 disableJsInterface 会修改此方法。
  - showUpX5WebView
```
void showUpX5WebView(java.lang.Object x5WebView)
```
    向腾讯 x5WebView 注入本地方法, 默认不开启认证校验。
    
    参数:
    
    x5WebView - 腾讯 x5WebView
  - isVisualizedAutoTrackActivity
```
boolean isVisualizedAutoTrackActivity(java.lang.Class<?> activity)
```
    activity 是否开启了可视化全埋点
    
    参数:
    
    activity - activity 类的对象
    
    返回:
    
    true 代表 activity 开启了可视化全埋点，false 代表 activity 关闭了可视化全埋点
  - addVisualizedAutoTrackActivity
```
void addVisualizedAutoTrackActivity(java.lang.Class<?> activity)
```
    开启某个 activity 的可视化全埋点
    
    参数:
    
    activity - activity 类的对象
  - addVisualizedAutoTrackActivities
```
void addVisualizedAutoTrackActivities(java.util.List<java.lang.Class<?>> activitiesList)
```
    开启多个 activity 的可视化全埋点
    
    参数:
    
    activitiesList - activity 类的对象集合
  - isVisualizedAutoTrackEnabled
```
boolean isVisualizedAutoTrackEnabled()
```
    是否开启可视化全埋点
    
    返回:
    
    true 代表开启了可视化全埋点， false 代表关闭了可视化全埋点
  - isHeatMapActivity
```
boolean isHeatMapActivity(java.lang.Class<?> activity)
```
    activity 是否开启了点击图
    
    参数:
    
    activity - activity 类的对象
    
    返回:
    
    true 代表 activity 开启了点击图， false 代表 activity 关闭了点击图
  - addHeatMapActivity
```
void addHeatMapActivity(java.lang.Class<?> activity)
```
    开启某个 activity 的点击图
    
    参数:
    
    activity - activity 类的对象
  - addHeatMapActivities
```
void addHeatMapActivities(java.util.List<java.lang.Class<?>> activitiesList)
```
    开启多个 activity 的点击图
    
    参数:
    
    activitiesList - activity 类的对象集合
  - isHeatMapEnabled
```
boolean isHeatMapEnabled()
```
    是否开启点击图
    
    返回:
    
    true 代表开启了点击图，false 代表关闭了点击图
  - getDistinctId
```
java.lang.String getDistinctId()
```
    获取当前用户的 distinctId
    
    指定者:
    
    getDistinctId 在接口中 IUserIdentityAPI
    
    返回:
    
    优先返回登录 ID，登录 ID 为空时，返回匿名 ID
  - getAnonymousId
```
java.lang.String getAnonymousId()
```
    获取当前用户的匿名 ID 若调用前未调用 identify(String) 设置用户的匿名 ID，SDK 会优先调用 SensorsDataUtils#getAndroidID 获取 Android ID，如获取的 Android ID 非法，则调用 UUID 随机生成 UUID，作为用户的匿名 ID
    
    指定者:
    
    getAnonymousId 在接口中 IUserIdentityAPI
    
    返回:
    
    当前用户的匿名 ID
  - resetAnonymousId
```
@Deprecated
void resetAnonymousId()
```
    已过时。
    
    重置默认匿名id
    
    指定者:
    
    resetAnonymousId 在接口中 IUserIdentityAPI
  - getLoginId
```
java.lang.String getLoginId()
```
    获取当前用户的 loginId 若调用前未调用 login(String) 设置用户的 loginId，会返回 null
    
    指定者:
    
    getLoginId 在接口中 IUserIdentityAPI
    
    返回:
    
    当前用户的 loginId
  - identify
```
void identify(java.lang.String distinctId)
```
    设置当前用户的 distinctId。一般情况下，如果是一个注册用户，则应该使用注册系统内的 user_id，如果是个未注册用户，则可以选择一个不会重复的匿名 ID，如设备 ID 等，如果客户没有调用 identify，则使用SDK自动生成的匿名 ID
    
    指定者:
    
    identify 在接口中 IUserIdentityAPI
    
    参数:
    
    distinctId - 当前用户的 distinctId，仅接受数字、下划线和大小写字母
  - login
```
void login(java.lang.String loginId)
```
    登录，设置当前用户的 loginId
    
    指定者:
    
    login 在接口中 IUserIdentityAPI
    
    参数:
    
    loginId - 当前用户的 loginId，不能为空，且长度不能大于 255
  - login
```
void login(java.lang.String loginId,
           org.json.JSONObject properties)
```
    登录，设置当前用户的 loginId
    
    指定者:
    
    login 在接口中 IUserIdentityAPI
    
    参数:
    
    loginId - 当前用户的 loginId，不能为空，且长度不能大于 255
    
    properties - 用户登录属性
  - logout
```
void logout()
```
    注销，清空当前用户的 loginId
    
    指定者:
    
    logout 在接口中 IUserIdentityAPI
  - track
```
void track(java.lang.String eventName,
           org.json.JSONObject properties)
```
  - track
```
void track(java.lang.String eventName)
```
    与 track(String, JSONObject) 类似，无事件属性
    
    参数:
    
    eventName - 事件的名称
  - trackTimer
```
@Deprecated
void trackTimer(java.lang.String eventName,
                            java.util.concurrent.TimeUnit timeUnit)
```
    已过时。
    
    初始化事件的计时器。若需要统计某个事件的持续时间，先在事件开始时调用 trackTimer("Event") 记录事件开始时间，该方法并不会真正发送事件；随后在事件结束时，调用 track("Event", properties)，SDK 会追踪 "Event" 事件，并自动将事件持续时间记录在事件属性 "event_duration" 中。多次调用 trackTimer("Event") 时，事件 "Event" 的开始时间以最后一次调用时为准。
    
    参数:
    
    eventName - 事件的名称
    
    timeUnit - 计时结果的时间单位
  - removeTimer
```
void removeTimer(java.lang.String eventName)
```
    删除事件的计时器
    
    参数:
    
    eventName - 事件名称
  - trackTimerEnd
```
void trackTimerEnd(java.lang.String eventName,
                   org.json.JSONObject properties)
```
    停止事件计时器
    
    参数:
    
    eventName - 事件的名称，或者交叉计算场景时 trackTimerStart 的返回值
    
    properties - 事件的属性
  - trackTimerEnd
```
void trackTimerEnd(java.lang.String eventName)
```
    停止事件计时器
    
    参数:
    
    eventName - 事件的名称，或者交叉计算场景时 trackTimerStart 的返回值
  - clearTrackTimer
```
void clearTrackTimer()
```
    清除所有事件计时器
  - flush
```
void flush()
```
    将所有本地缓存的日志发送到 Sensors Analytics.
  - flushSync
```
void flushSync()
```
    将所有本地缓存的日志发送到 Sensors Analytics.
  - flushScheduled
```
void flushScheduled()
```
    以轮询形式将所有本地缓存的日志发送到 Sensors Analytics.
  - registerDynamicSuperProperties
```
void registerDynamicSuperProperties(SensorsDataDynamicSuperProperties dynamicSuperProperties)
```
    注册事件动态公共属性
    
    参数:
    
    dynamicSuperProperties - 事件动态公共属性回调接口
  - setTrackEventCallBack
```
void setTrackEventCallBack(SensorsDataTrackEventCallBack trackEventCallBack)
```
    设置 track 事件回调
    
    参数:
    
    trackEventCallBack - track 事件回调接口
  - getSuperProperties
```
org.json.JSONObject getSuperProperties()
```
    获取事件公共属性
    
    返回:
    
    当前所有 Super 属性
  - registerSuperProperties
```
void registerSuperProperties(org.json.JSONObject superProperties)
```
    注册所有事件都有的公共属性
    
    参数:
    
    superProperties - 事件公共属性
  - unregisterSuperProperty
```
void unregisterSuperProperty(java.lang.String superPropertyName)
```
    删除事件公共属性
    
    参数:
    
    superPropertyName - 事件属性名称
  - registerPropertyPlugin
```
void registerPropertyPlugin(SAPropertyPlugin plugin)
```
    注册自定义插件
    
    参数:
    
    plugin - 自定义插件
  - unregisterPropertyPlugin
```
void unregisterPropertyPlugin(SAPropertyPlugin plugin)
```
    注销自定义插件
    
    参数:
    
    plugin - 自定义插件
  - clearSuperProperties
```
void clearSuperProperties()
```
    删除所有事件公共属性
  - profileSet
```
void profileSet(org.json.JSONObject properties)
```
    设置用户的一个或多个 Profile。 Profile如果存在，则覆盖；否则，新创建。
    
    参数:
    
    properties - 属性列表
  - profileSet
```
void profileSet(java.lang.String property,
                java.lang.Object value)
```
    设置用户的一个 Profile，如果之前存在，则覆盖，否则，新创建
    
    参数:
    
    property - 属性名称
    
    value - 属性的值，值的类型只允许为 String, Number, Date, Boolean, JSONArray
  - profileSetOnce
```
void profileSetOnce(org.json.JSONObject properties)
```
    首次设置用户的一个或多个 Profile。与profileSet接口不同的是，如果之前存在，则忽略，否则，新创建
    
    参数:
    
    properties - 属性列表
  - profileSetOnce
```
void profileSetOnce(java.lang.String property,
                    java.lang.Object value)
```
    首次设置用户的一个 Profile 与profileSet接口不同的是，如果之前存在，则忽略，否则，新创建
    
    参数:
    
    property - 属性名称
    
    value - 属性的值，值的类型只允许为 String, Number, Date, Boolean, JSONArray
  - profileIncrement
```
void profileIncrement(java.util.Map<java.lang.String,? extends java.lang.Number> properties)
```
    给一个或多个数值类型的 Profile 增加一个数值。只能对数值型属性进行操作，若该属性未设置，则添加属性并设置默认值为 0
    
    参数:
    
    properties - 一个或多个属性集合
  - profileIncrement
```
void profileIncrement(java.lang.String property,
                      java.lang.Number value)
```
    给一个数值类型的 Profile 增加一个数值。只能对数值型属性进行操作，若该属性未设置，则添加属性并设置默认值为 0
    
    参数:
    
    property - 属性名称
    
    value - 属性的值，值的类型只允许为 Number
  - profileAppend
```
void profileAppend(java.lang.String property,
                   java.lang.String value)
```
    给一个列表类型的 Profile 增加一个元素
    
    参数:
    
    property - 属性名称
    
    value - 新增的元素
  - profileAppend
```
void profileAppend(java.lang.String property,
                   java.util.Set<java.lang.String> values)
```
    给一个列表类型的 Profile 增加一个或多个元素
    
    参数:
    
    property - 属性名称
    
    values - 新增的元素集合
  - profileUnset
```
void profileUnset(java.lang.String property)
```
    删除用户的一个 Profile
    
    参数:
    
    property - 属性名称
  - profileDelete
```
void profileDelete()
```
    删除用户所有 Profile
  - setGPSLocation
```
void setGPSLocation(double latitude,
                    double longitude)
```
    更新 GPS 位置信息
    
    参数:
    
    latitude - 纬度
    
    longitude - 经度
  - setGPSLocation
```
void setGPSLocation(double latitude,
                    double longitude,
                    java.lang.String coordinate)
```
    更新 GPS 位置信息及对应坐标系
    
    参数:
    
    latitude - 纬度
    
    longitude - 经度
    
    coordinate - 坐标系，坐标系类型请参照 SensorsDataGPSLocation.CoordinateType
  - clearGPSLocation
```
void clearGPSLocation()
```
    清除 GPS 位置信息
  - enableTrackScreenOrientation
```
void enableTrackScreenOrientation(boolean enable)
```
    开启/关闭采集屏幕方向
    
    参数:
    
    enable - true：开启 false：关闭
  - resumeTrackScreenOrientation
```
void resumeTrackScreenOrientation()
```
    恢复采集屏幕方向
  - stopTrackScreenOrientation
```
void stopTrackScreenOrientation()
```
    暂停采集屏幕方向
  - getScreenOrientation
```
java.lang.String getScreenOrientation()
```
    获取当前屏幕方向
    
    返回:
    
    portrait:竖屏 landscape:横屏
  - trackTimerStart
```
java.lang.String trackTimerStart(java.lang.String eventName)
```
    初始化事件的计时器，计时单位为秒。
    
    参数:
    
    eventName - 事件的名称
    
    返回:
    
    交叉计时的事件名称
  - trackTimerPause
```
void trackTimerPause(java.lang.String eventName)
```
    暂停事件计时器，计时单位为秒。
    
    参数:
    
    eventName - 事件的名称
  - trackTimerResume
```
void trackTimerResume(java.lang.String eventName)
```
    恢复事件计时器，计时单位为秒。
    
    参数:
    
    eventName - 事件的名称
  - setCookie
```
void setCookie(java.lang.String cookie,
               boolean encode)
```
    设置 Cookie，flush 的时候会设置 HTTP 的 cookie 内部会 URLEncoder.encode(cookie, "UTF-8")
    
    参数:
    
    cookie - String cookie
    
    encode - boolean 是否 encode
  - getCookie
```
java.lang.String getCookie(boolean decode)
```
    获取已设置的 Cookie URLDecoder.decode(Cookie, "UTF-8")
    
    参数:
    
    decode - String
    
    返回:
    
    String cookie
  - deleteAll
```
void deleteAll()
```
    删除本地缓存的全部事件
  - profilePushId
```
void profilePushId(java.lang.String pushTypeKey,
                   java.lang.String pushId)
```
    保存用户推送 ID 到用户表
    
    参数:
    
    pushTypeKey - 属性名称（例如 jgId）
    
    pushId - 推送 ID 使用 profilePushId("jgId",JPushInterface.getRegistrationID(this))
  - profileUnsetPushId
```
void profileUnsetPushId(java.lang.String pushTypeKey)
```
    删除用户设置的 pushId
    
    参数:
    
    pushTypeKey - 属性名称（例如 jgId）
  - itemSet
```
void itemSet(java.lang.String itemType,
             java.lang.String itemId,
             org.json.JSONObject properties)
```
    设置 item
    
    参数:
    
    itemType - item 类型
    
    itemId - item ID
    
    properties - item 相关属性
  - itemDelete
```
void itemDelete(java.lang.String itemType,
                java.lang.String itemId)
```
    删除 item
    
    参数:
    
    itemType - item 类型
    
    itemId - item ID
  - stopTrackThread
```
void stopTrackThread()
```
    停止事件采集，注意不要随便调用，调用后会造成数据丢失。
  - startTrackThread
```
void startTrackThread()
```
    开启事件采集
  - enableDeepLinkInstallSource
```
void enableDeepLinkInstallSource(boolean enable)
```
    DeepLink 是否采集设备信息
    
    指定者:
    
    enableDeepLinkInstallSource 在接口中 SAAdvertAPIProtocol
    
    参数:
    
    enable - 是否开启采集设备信息
  - trackDeepLinkLaunch
```
void trackDeepLinkLaunch(java.lang.String deepLinkUrl)
```
    记录 $AppDeepLinkLaunch trackDeepLinkLaunch(String, String)}事件
    
    指定者:
    
    trackDeepLinkLaunch 在接口中 SAAdvertAPIProtocol
    
    参数:
    
    deepLinkUrl - 唤起应用的 DeepLink 链接
  - trackDeepLinkLaunch
```
void trackDeepLinkLaunch(java.lang.String deepLinkUrl,
                         java.lang.String oaid)
```
    记录 $AppDeepLinkLaunch 事件
    
    指定者:
    
    trackDeepLinkLaunch 在接口中 SAAdvertAPIProtocol
    
    参数:
    
    deepLinkUrl - 唤起应用的 DeepLink 链接
    
    oaid - oaid
  - registerLimitKeys
```
void registerLimitKeys(java.util.Map<java.lang.String,java.lang.String> limitKeys)
```
    注册限制性属性 key
    
    参数:
    
    limitKeys - 限制性属性 key
  - enableRemoteConfig
```
void enableRemoteConfig(boolean enable)
```
    是否开启远程配置
    
    参数:
    
    enable - true 开启，false 不开启

接口 ISensorsDataAPI

字段概要

从接口继承的字段 com.sensorsdata.analytics.android.sdk.useridentity.IUserIdentityAPI

方法概要

从接口继承的方法 com.sensorsdata.analytics.android.sdk.useridentity.IUserIdentityAPI

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.advert.SAAdvertAPIProtocol

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.autotrack.AutoTrackProtocol

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.autotrack.IFragmentAPI

从接口继承的方法 com.sensorsdata.analytics.android.sdk.core.mediator.exposure.SAExposureAPIProtocol

方法详细资料

getPresetProperties

getServerUrl

setServerUrl

setServerUrl

enableLog

getMaxCacheSize

setMaxCacheSize

isDebugMode

isNetworkRequestEnable

enableNetworkRequest

setFlushNetworkPolicy

getFlushInterval

setFlushInterval

getFlushBulkSize

setFlushBulkSize

getSessionIntervalTime

setSessionIntervalTime

showUpWebView

showUpWebView

showUpWebView

showUpWebView

showUpX5WebView

showUpX5WebView

showUpX5WebView

isVisualizedAutoTrackActivity

addVisualizedAutoTrackActivity

addVisualizedAutoTrackActivities

isVisualizedAutoTrackEnabled

isHeatMapActivity

addHeatMapActivity

addHeatMapActivities

isHeatMapEnabled

getDistinctId

getAnonymousId

resetAnonymousId

getLoginId

identify

login

login

logout

track

track

trackTimer

removeTimer

trackTimerEnd

trackTimerEnd

clearTrackTimer

flush

flushSync

flushScheduled

registerDynamicSuperProperties

setTrackEventCallBack

getSuperProperties

registerSuperProperties

unregisterSuperProperty

registerPropertyPlugin

unregisterPropertyPlugin

clearSuperProperties

profileSet

profileSet

profileSetOnce

profileSetOnce

profileIncrement

profileIncrement

profileAppend

profileAppend

profileUnset

profileDelete

setGPSLocation

setGPSLocation