SAConfigOptions (SensorsAnalyticsSDK 6.2.8 API)

java.lang.Object
- com.sensorsdata.analytics.android.sdk.SAConfigOptions

所有已实现的接口:: java.lang.Cloneable

public final class SAConfigOptions
extends java.lang.Object
implements java.lang.Cloneable

字段概要

字段
限定符和类型	字段和说明
`boolean`	`mDisableDebugAssistant` 禁用辅助工具
`boolean`	`mDisableRandomTimeRequestRemoteConfig` 禁用随机时间请求远程配置
`boolean`	`mEnableTrackPush` 是否开启推送点击采集
`protected boolean`	`mIsTrackFragmentPageLeave` 是否采集 Fragment 页面停留时长
`protected boolean`	`mIsTrackPageLeave` 开启采集页面停留时长
`int`	`mMaxRequestInterval` 远程配置请求最大间隔时长，单位：小时，默认 48
`int`	`mMinRequestInterval` 远程配置请求最小间隔时长，单位：小时，默认 24
`java.lang.String`	`mRemoteConfigUrl` 请求配置地址，默认从 ServerUrl 解析
`javax.net.ssl.SSLSocketFactory`	`mSSLSocketFactory` 设置 SSLSocketFactory

构造器概要

构造器
构造器和说明

SAConfigOptions(java.lang.String serverUrl)
获取 SAOptionsConfig 实例

构造器
构造器和说明
`SAConfigOptions(java.lang.String serverUrl)` 获取 SAOptionsConfig 实例

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected SAConfigOptions`	`clone()`
`SAConfigOptions`	`disableDataCollect()` 已过时。
`SAConfigOptions`	`disableDebugAssistant()` 禁用辅助工具
`SAConfigOptions`	`disableDeviceId()` 将 $device_id 修改为 $anonymization_id
`SAConfigOptions`	`disableRandomTimeRequestRemoteConfig()` 禁用分散请求远程配置
`SAConfigOptions`	`disableSDK(boolean disableSDK)` 是否关闭 SDK
`SAConfigOptions`	`enableAutoAddChannelCallbackEvent(boolean isAutoAddChannelCallbackEvent)` 是否在手动埋点事件中自动添加渠道匹配信息
`SAConfigOptions`	`enableEncrypt(boolean enableEncrypt)` 是否开启加密
`SAConfigOptions`	`enableHeatMap(boolean enableHeatMap)` 设置点击图是否可用
`SAConfigOptions`	`enableJavaScriptBridge(boolean isSupportJellyBean)` 开启自动打通所有的 WebView H5 功能。
`SAConfigOptions`	`enableLog(boolean enableLog)` 是否打印日志
`SAConfigOptions`	`enableSaveDeepLinkInfo(boolean enableSave)` 设置是否保存 utm 属性
`SAConfigOptions`	`enableSession(boolean enableSession)` 是否开启 session_id 的采集
`SAConfigOptions`	`enableSubProcessFlushData()` 是否多进程上报数据
`SAConfigOptions`	`enableTrackAppCrash()` 设置是否开启 AppCrash 采集，默认是关闭的
`SAConfigOptions`	`enableTrackPageLeave(boolean isTrackPageLeave)` 已过时。
`SAConfigOptions`	`enableTrackPageLeave(boolean isTrackPageLeave, boolean isTrackFragmentPageLeave)` 是否开启页面停留时长
`SAConfigOptions`	`enableTrackPush(boolean enableTrackPush)` 是否开启 push 点击的采集
`SAConfigOptions`	`enableTrackScreenOrientation(boolean enableScreenOrientation)` 是否开启屏幕方向采集
`SAConfigOptions`	`enableVisualizedAutoTrack(boolean enableVisualizedAutoTrack)` 设置可视化全埋点是否可用
`SAConfigOptions`	`enableVisualizedProperties(boolean enableVisualizedProperties)` 设置可视化全埋点自定义属性是否可用
`java.util.List<SAEncryptListener>`	`getEncryptors()` 获取注册的加密插件列表
`java.lang.String`	`getLoginIDKey()` 获取 LoginID Key
`java.util.List<StorePlugin>`	`getStorePlugins()`
`SAConfigOptions`	`ignorePageLeave(java.util.List<java.lang.Class<?>> ignoreList)` 指定哪些 Activity/Fragment 不采集页面停留时长指定 Activity/Fragment 的格式为：****.class
`boolean`	`isDataCollect()`
`boolean`	`isDataCollectEnable()` 是否开启数据采集
`boolean`	`isDisableDeviceId()` 是否将 $device_id 修改为 $anonymization_id
`boolean`	`isDisableSDK()` 是否禁止 SDK
`boolean`	`isEnableSession()` 是否开启 session_id 的采集
`boolean`	`isEnableTrackPush()` 是否开启推送
`boolean`	`isMultiProcessFlush()` 是否允许多进程上报数据
`boolean`	`isSaveDeepLinkInfo()` 是否开启 DeepLink
`boolean`	`isTrackFragmentPageLeave()` 是否开启页面停留时长采集
`boolean`	`isTrackPageLeave()` 是否开启页面停留时长采集
`boolean`	`isVisualizedPropertiesEnabled()` 自定义属性是否可用
`SAConfigOptions`	`persistentSecretKey(IPersistentSecretKey persistentSecretKey)` 密钥回调监听
`SAConfigOptions`	`registerEncryptor(SAEncryptListener encryptListener)` 注册自定义加密插件
`SAConfigOptions`	`registerStorePlugin(StorePlugin plugin)` 注册自定义插件，适用于 SP 加密
`SAConfigOptions`	`setAutoTrackEventType(int autoTrackEventType)` 设置 AutoTrackEvent 的类型，可通过 '\|' 进行连接
`SAConfigOptions`	`setFlushBulkSize(int flushBulkSize)` 设置本地缓存日志的最大条目数
`SAConfigOptions`	`setFlushInterval(int flushInterval)` 设置两次数据发送的最小时间间隔，最小值 5 秒
`SAConfigOptions`	`setLoginIDKey(java.lang.String loginIDKey)` 自定义 LoginID Key
`SAConfigOptions`	`setMaxCacheSize(long maxCacheSize)` 设置本地缓存上限值，单位 byte，默认为 32MB：32 * 1024 * 1024，最小 16MB：16 * 1024 * 1024，若小于 16MB，则按 16MB 处理。
`SAConfigOptions`	`setMaxRequestInterval(int maxRequestInterval)` 设置远程配置请求最大间隔时长
`SAConfigOptions`	`setMinRequestInterval(int minRequestInterval)` 设置远程配置请求最小间隔时长
`SAConfigOptions`	`setNetworkTypePolicy(int networkTypePolicy)` 设置数据的网络上传策略
`SAConfigOptions`	`setRemoteConfigUrl(java.lang.String remoteConfigUrl)` 设置远程配置请求地址
`SAConfigOptions`	`setServerUrl(java.lang.String serverUrl)` 设置数据上报地址
`SAConfigOptions`	`setSourceChannels(java.lang.String... channels)` 用户需采集渠道信息自定义属性 key 值，可传多个。
`SAConfigOptions`	`setSSLSocketFactory(javax.net.ssl.SSLSocketFactory SSLSocketFactory)` 设置 SSLSocketFactory，HTTPS 请求连接时需要使用

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - mRemoteConfigUrl
```
public java.lang.String mRemoteConfigUrl
```
    请求配置地址，默认从 ServerUrl 解析
  - mMinRequestInterval
```
public int mMinRequestInterval
```
    远程配置请求最小间隔时长，单位：小时，默认 24
  - mMaxRequestInterval
```
public int mMaxRequestInterval
```
    远程配置请求最大间隔时长，单位：小时，默认 48
  - mDisableRandomTimeRequestRemoteConfig
```
public boolean mDisableRandomTimeRequestRemoteConfig
```
    禁用随机时间请求远程配置
  - mSSLSocketFactory
```
public javax.net.ssl.SSLSocketFactory mSSLSocketFactory
```
    设置 SSLSocketFactory
  - mDisableDebugAssistant
```
public boolean mDisableDebugAssistant
```
    禁用辅助工具
  - mEnableTrackPush
```
public boolean mEnableTrackPush
```
    是否开启推送点击采集
  - mIsTrackPageLeave
```
protected boolean mIsTrackPageLeave
```
    开启采集页面停留时长
  - mIsTrackFragmentPageLeave
```
protected boolean mIsTrackFragmentPageLeave
```
    是否采集 Fragment 页面停留时长
- 构造器详细资料
  - SAConfigOptions
```
public SAConfigOptions(java.lang.String serverUrl)
```
    获取 SAOptionsConfig 实例
    
    参数:
    
    serverUrl，数据上报服务器地址 -
- 方法详细资料
  - setRemoteConfigUrl
```
public SAConfigOptions setRemoteConfigUrl(java.lang.String remoteConfigUrl)
```
    设置远程配置请求地址
    
    参数:
    
    remoteConfigUrl，远程配置请求地址 -
    
    返回:
    
    SAOptionsConfig
  - setServerUrl
```
public SAConfigOptions setServerUrl(java.lang.String serverUrl)
```
    设置数据上报地址
    
    参数:
    
    serverUrl，数据上报地址 -
    
    返回:
    
    SAOptionsConfig
  - setAutoTrackEventType
```
public SAConfigOptions setAutoTrackEventType(int autoTrackEventType)
```
    设置 AutoTrackEvent 的类型，可通过 '|' 进行连接
    
    参数:
    
    autoTrackEventType - 开启的 AutoTrack 类型
    
    返回:
    
    SAOptionsConfig
  - enableTrackAppCrash
```
public SAConfigOptions enableTrackAppCrash()
```
    设置是否开启 AppCrash 采集，默认是关闭的
    
    返回:
    
    SAOptionsConfig
  - setFlushInterval
```
public SAConfigOptions setFlushInterval(int flushInterval)
```
    设置两次数据发送的最小时间间隔，最小值 5 秒
    
    参数:
    
    flushInterval - 时间间隔，单位毫秒
    
    返回:
    
    SAOptionsConfig
  - setFlushBulkSize
```
public SAConfigOptions setFlushBulkSize(int flushBulkSize)
```
    设置本地缓存日志的最大条目数
    
    参数:
    
    flushBulkSize - 缓存数目
    
    返回:
    
    SAOptionsConfig
  - setMaxCacheSize
```
public SAConfigOptions setMaxCacheSize(long maxCacheSize)
```
    设置本地缓存上限值，单位 byte，默认为 32MB：32 * 1024 * 1024，最小 16MB：16 * 1024 * 1024，若小于 16MB，则按 16MB 处理。
    
    参数:
    
    maxCacheSize - 单位 byte
    
    返回:
    
    SAOptionsConfig
  - setMinRequestInterval
```
public SAConfigOptions setMinRequestInterval(int minRequestInterval)
```
    设置远程配置请求最小间隔时长
    
    参数:
    
    minRequestInterval - 最小时长间隔，单位：小时，默认 24，合法区间在(0, 7*24] 之间
    
    返回:
    
    SAOptionsConfig
  - setMaxRequestInterval
```
public SAConfigOptions setMaxRequestInterval(int maxRequestInterval)
```
    设置远程配置请求最大间隔时长
    
    参数:
    
    maxRequestInterval - 最大时长间隔，单位：小时，默认 48，合法区间在(0, 7*24] 之间
    
    返回:
    
    SAOptionsConfig
  - disableRandomTimeRequestRemoteConfig
```
public SAConfigOptions disableRandomTimeRequestRemoteConfig()
```
    禁用分散请求远程配置
    
    返回:
    
    SAOptionsConfig
  - disableDebugAssistant
```
public SAConfigOptions disableDebugAssistant()
```
    禁用辅助工具
    
    返回:
    
    SAOptionsConfig
  - enableHeatMap
```
public SAConfigOptions enableHeatMap(boolean enableHeatMap)
```
    设置点击图是否可用
    
    参数:
    
    enableHeatMap - 点击图是否可用
    
    返回:
    
    SAOptionsConfig
  - enableVisualizedProperties
```
public SAConfigOptions enableVisualizedProperties(boolean enableVisualizedProperties)
```
    设置可视化全埋点自定义属性是否可用
    
    参数:
    
    enableVisualizedProperties - 可视化全埋点自定义属性功能是否可用
    
    返回:
    
    SAConfigOptions
  - enableVisualizedAutoTrack
```
public SAConfigOptions enableVisualizedAutoTrack(boolean enableVisualizedAutoTrack)
```
    设置可视化全埋点是否可用
    
    参数:
    
    enableVisualizedAutoTrack - 可视化全埋点是否可用
    
    返回:
    
    SAOptionsConfig
  - enableLog
```
public SAConfigOptions enableLog(boolean enableLog)
```
    是否打印日志
    
    参数:
    
    enableLog - 是否开启打印日志
    
    返回:
    
    SAOptionsConfig
  - enableTrackScreenOrientation
```
public SAConfigOptions enableTrackScreenOrientation(boolean enableScreenOrientation)
```
    是否开启屏幕方向采集
    
    参数:
    
    enableScreenOrientation - 是否开启屏幕方向采集
    
    返回:
    
    SAOptionsConfig
  - setNetworkTypePolicy
```
public SAConfigOptions setNetworkTypePolicy(int networkTypePolicy)
```
    设置数据的网络上传策略
    
    参数:
    
    networkTypePolicy - 数据的网络上传策略
    
    返回:
    
    SAOptionsConfig
  - enableSaveDeepLinkInfo
```
public SAConfigOptions enableSaveDeepLinkInfo(boolean enableSave)
```
    设置是否保存 utm 属性
    
    参数:
    
    enableSave - boolean 默认 false 不保存
    
    返回:
    
    SAConfigOptions
  - setSourceChannels
```
public SAConfigOptions setSourceChannels(java.lang.String... channels)
```
    用户需采集渠道信息自定义属性 key 值，可传多个。
    
    参数:
    
    channels - 渠道信息自定义属性 key 值
    
    返回:
    
    SAConfigOptions
  - enableJavaScriptBridge
```
public SAConfigOptions enableJavaScriptBridge(boolean isSupportJellyBean)
```
    开启自动打通所有的 WebView H5 功能。目前支持的 Android 系统自带的 WebView 以及腾讯的 x5WebView.
    
    参数:
    
    isSupportJellyBean - 是否支持 API level 16 及以下的版本。因为 API level 16 及以下的版本，addJavascriptInterface 有安全漏洞，请谨慎使用。
    
    返回:
    
    SAConfigOptions
  - enableAutoAddChannelCallbackEvent
```
public SAConfigOptions enableAutoAddChannelCallbackEvent(boolean isAutoAddChannelCallbackEvent)
```
    是否在手动埋点事件中自动添加渠道匹配信息
    
    参数:
    
    isAutoAddChannelCallbackEvent - true: 开启，false: 不开启，默认是 false
    
    返回:
    
    SAConfigOptions
  - enableEncrypt
```
public SAConfigOptions enableEncrypt(boolean enableEncrypt)
```
    是否开启加密
    
    参数:
    
    enableEncrypt - 是否开启加密
    
    返回:
    
    SAConfigOptions
  - persistentSecretKey
```
public SAConfigOptions persistentSecretKey(IPersistentSecretKey persistentSecretKey)
```
    密钥回调监听
    
    参数:
    
    persistentSecretKey - 密钥回调监听
    
    返回:
    
    SAConfigOptions
  - enableSubProcessFlushData
```
public SAConfigOptions enableSubProcessFlushData()
```
    是否多进程上报数据
    
    返回:
    
    SAConfigOptions
  - disableDataCollect
```
@Deprecated
public SAConfigOptions disableDataCollect()
```
    已过时。
    
    禁用数据采集
    
    返回:
    
    SAConfigOptions
  - isDataCollect
```
public boolean isDataCollect()
```
  - setSSLSocketFactory
```
public SAConfigOptions setSSLSocketFactory(javax.net.ssl.SSLSocketFactory SSLSocketFactory)
```
    设置 SSLSocketFactory，HTTPS 请求连接时需要使用
    
    参数:
    
    SSLSocketFactory - 证书
    
    返回:
    
    SAConfigOptions
  - enableTrackPush
```
public SAConfigOptions enableTrackPush(boolean enableTrackPush)
```
    是否开启 push 点击的采集
    
    参数:
    
    enableTrackPush - 是否开启 push 点击的采集
    
    返回:
    
    SAConfigOptions
  - disableSDK
```
public SAConfigOptions disableSDK(boolean disableSDK)
```
    是否关闭 SDK
    
    参数:
    
    disableSDK - 是否关闭 SDK
    
    返回:
    
    SAConfigOptions
  - enableTrackPageLeave
```
@Deprecated
public SAConfigOptions enableTrackPageLeave(boolean isTrackPageLeave)
```
    已过时。
    
    是否开启页面停留时长
    
    参数:
    
    isTrackPageLeave - 是否开启页面停留时长
    
    返回:
    
    SAConfigOptions
  - enableTrackPageLeave
```
public SAConfigOptions enableTrackPageLeave(boolean isTrackPageLeave,
                                            boolean isTrackFragmentPageLeave)
```
    是否开启页面停留时长
    
    参数:
    
    isTrackPageLeave - 是否开启页面停留时长
    
    isTrackFragmentPageLeave - 是否采集 Fragment 页面停留时长，需开启页面停留时长采集
    
    返回:
    
    SAConfigOptions
  - ignorePageLeave
```
public SAConfigOptions ignorePageLeave(java.util.List<java.lang.Class<?>> ignoreList)
```
    指定哪些 Activity/Fragment 不采集页面停留时长指定 Activity/Fragment 的格式为：****.class
    
    参数:
    
    ignoreList - activity/Fragment 列表
  - registerEncryptor
```
public SAConfigOptions registerEncryptor(SAEncryptListener encryptListener)
```
    注册自定义加密插件
    
    参数:
    
    encryptListener - 自定义加密实现接口
    
    返回:
    
    SAConfigOptions
  - registerStorePlugin
```
public SAConfigOptions registerStorePlugin(StorePlugin plugin)
```
    注册自定义插件，适用于 SP 加密
    
    参数:
    
    plugin - 自定义插件
    
    返回:
    
    SAConfigOptions
  - setLoginIDKey
```
public SAConfigOptions setLoginIDKey(java.lang.String loginIDKey)
```
    自定义 LoginID Key
    
    参数:
    
    loginIDKey - LoginID Key
    
    返回:
    
    SAConfigOptions
  - disableDeviceId
```
public SAConfigOptions disableDeviceId()
```
    将 $device_id 修改为 $anonymization_id
    
    返回:
    
    SAConfigOptions
  - getLoginIDKey
```
public java.lang.String getLoginIDKey()
```
    获取 LoginID Key
    
    返回:
    
    LoginID Key
  - clone
```
protected SAConfigOptions clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - enableSession
```
public SAConfigOptions enableSession(boolean enableSession)
```
    是否开启 session_id 的采集
    
    参数:
    
    enableSession - 是否开启 Session 采集
    
    返回:
    
    SAConfigOptions
  - isDataCollectEnable
```
public boolean isDataCollectEnable()
```
    是否开启数据采集
    
    返回:
    
    true 开启，false 未开启
  - isSaveDeepLinkInfo
```
public boolean isSaveDeepLinkInfo()
```
    是否开启 DeepLink
    
    返回:
    
    true 开启，false 未开启
  - isMultiProcessFlush
```
public boolean isMultiProcessFlush()
```
    是否允许多进程上报数据
    
    返回:
    
    true 开启，false 未开启
  - isTrackPageLeave
```
public boolean isTrackPageLeave()
```
    是否开启页面停留时长采集
    
    返回:
    
    true 开启，false 未开启
  - isTrackFragmentPageLeave
```
public boolean isTrackFragmentPageLeave()
```
    是否开启页面停留时长采集
    
    返回:
    
    true 开启，false 未开启
  - getEncryptors
```
public java.util.List<SAEncryptListener> getEncryptors()
```
    获取注册的加密插件列表
    
    返回:
    
    注册的加密插件列表
  - isDisableSDK
```
public boolean isDisableSDK()
```
    是否禁止 SDK
    
    返回:
    
    true 禁止了 SDK，false 未禁止
  - isEnableSession
```
public boolean isEnableSession()
```
    是否开启 session_id 的采集
    
    返回:
    
    true 开启，false 关闭
  - isEnableTrackPush
```
public boolean isEnableTrackPush()
```
    是否开启推送
    
    返回:
    
    true 开启推送，false 禁止推送
  - isVisualizedPropertiesEnabled
```
public boolean isVisualizedPropertiesEnabled()
```
    自定义属性是否可用
    
    返回:
    
    true 可用，false 不可用
  - getStorePlugins
```
public java.util.List<StorePlugin> getStorePlugins()
```
  - isDisableDeviceId
```
public boolean isDisableDeviceId()
```
    是否将 $device_id 修改为 $anonymization_id
    
    返回:
    
    false 不替换、true 替换

类 SAConfigOptions

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

mRemoteConfigUrl

mMinRequestInterval

mMaxRequestInterval

mDisableRandomTimeRequestRemoteConfig

mSSLSocketFactory

mDisableDebugAssistant

mEnableTrackPush

mIsTrackPageLeave

mIsTrackFragmentPageLeave

构造器详细资料

SAConfigOptions

方法详细资料

setRemoteConfigUrl

setServerUrl

setAutoTrackEventType

enableTrackAppCrash

setFlushInterval

setFlushBulkSize

setMaxCacheSize

setMinRequestInterval

setMaxRequestInterval

disableRandomTimeRequestRemoteConfig

disableDebugAssistant

enableHeatMap

enableVisualizedProperties

enableVisualizedAutoTrack

enableLog

enableTrackScreenOrientation

setNetworkTypePolicy

enableSaveDeepLinkInfo

setSourceChannels

enableJavaScriptBridge

enableAutoAddChannelCallbackEvent

enableEncrypt

persistentSecretKey

enableSubProcessFlushData

disableDataCollect

isDataCollect

setSSLSocketFactory

enableTrackPush

disableSDK

enableTrackPageLeave

enableTrackPageLeave

ignorePageLeave

registerEncryptor

registerStorePlugin

setLoginIDKey

disableDeviceId

getLoginIDKey

clone

enableSession

isDataCollectEnable

isSaveDeepLinkInfo

isMultiProcessFlush

isTrackPageLeave

isTrackFragmentPageLeave

getEncryptors

isDisableSDK

isEnableSession

isEnableTrackPush

isVisualizedPropertiesEnabled

getStorePlugins

isDisableDeviceId