com.sensorsdata.analytics.android.sdk.internal.api

类 UserIdentityAPI

java.lang.Object

com.sensorsdata.analytics.android.sdk.internal.api.UserIdentityAPI

所有已实现的接口:

IUserIdentityAPI

public final class UserIdentityAPI
extends java.lang.Object
implements IUserIdentityAPI

字段概要

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

BIND_ID, UNBIND_ID

构造器概要

构造器

构造器和说明
UserIdentityAPI(SAContextManager contextManager, SAConfigOptions saConfigOptions)

方法概要

限定符和类型	方法和说明
void	bind(java.lang.String key, java.lang.String value) 绑定业务 ID
void	enableDataCollect(java.lang.String androidId) 同意隐私权限
java.lang.String	getAnonymousId() 获取当前用户的匿名 ID 若调用前未调用 IUserIdentityAPI.identify(String) 设置用户的匿名 ID，SDK 会优先调用 SensorsDataUtils.getAndroidID(Context)获取 Android ID， 如获取的 Android ID 非法，则调用 UUID 随机生成 UUID，作为用户的匿名 ID
java.lang.String	getDistinctId() 获取当前用户的 distinctId
org.json.JSONObject	getIdentities(EventType eventType) 读取对应的 identities 属性
java.lang.String	getLoginId() 获取当前用户的 loginId 若调用前未调用 IUserIdentityAPI.login(String) 设置用户的 loginId，会返回 null
void	identify(java.lang.String distinctId) 设置当前用户的 distinctId。
boolean	isLoginIdValid(java.lang.String loginId) 是否合法的 LoginId，不等于登录 ID 且不等于匿名 ID，或者 LoginIdKey 发生变化且不等于匿名 ID
void	loadIdentitiesFromFile() 从本地缓存文件中加载 Identities
void	login(java.lang.String loginId) 登录，设置当前用户的 loginId
void	login(java.lang.String loginId, org.json.JSONObject properties) 登录，设置当前用户的 loginId
void	logout() 注销，清空当前用户的 loginId
void	mergeH5Identities(EventType eventType, org.json.JSONObject eventObject) 合并 H5 的 Identities 属性
void	resetAnonymousId() 重置默认匿名id
void	unbind(java.lang.String key, java.lang.String value) 解绑业务 ID
void	updateIdentities(org.json.JSONObject identitiesJson) 同意隐私权限时更新默认 ID
void	updateLoginId(java.lang.String loginId) 用于主线程调用 login 时及时更新 LoginId 值

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

UserIdentityAPI

public UserIdentityAPI(SAContextManager contextManager,
                       SAConfigOptions saConfigOptions)

方法详细资料

getDistinctId

public java.lang.String getDistinctId()

从接口复制的说明: IUserIdentityAPI

获取当前用户的 distinctId

指定者:

getDistinctId 在接口中 IUserIdentityAPI

返回:

优先返回登录 ID，登录 ID 为空时，返回匿名 ID

getAnonymousId

public java.lang.String getAnonymousId()

从接口复制的说明: IUserIdentityAPI

获取当前用户的匿名 ID 若调用前未调用 IUserIdentityAPI.identify(String) 设置用户的匿名 ID，SDK 会优先调用 SensorsDataUtils.getAndroidID(Context)获取 Android ID， 如获取的 Android ID 非法，则调用 UUID 随机生成 UUID，作为用户的匿名 ID

指定者:

getAnonymousId 在接口中 IUserIdentityAPI

返回:

当前用户的匿名 ID

resetAnonymousId

public void resetAnonymousId()

从接口复制的说明: IUserIdentityAPI

重置默认匿名id

指定者:

resetAnonymousId 在接口中 IUserIdentityAPI

getLoginId

public java.lang.String getLoginId()

从接口复制的说明: IUserIdentityAPI

获取当前用户的 loginId 若调用前未调用 IUserIdentityAPI.login(String) 设置用户的 loginId，会返回 null

指定者:

getLoginId 在接口中 IUserIdentityAPI

返回:

当前用户的 loginId

identify

public void identify(java.lang.String distinctId)

从接口复制的说明: IUserIdentityAPI

设置当前用户的 distinctId。一般情况下，如果是一个注册用户，则应该使用注册系统内 的 user_id，如果是个未注册用户，则可以选择一个不会重复的匿名 ID，如设备 ID 等，如果 客户没有调用 identify，则使用SDK自动生成的匿名 ID

指定者:

identify 在接口中 IUserIdentityAPI

参数:

distinctId - 当前用户的 distinctId，仅接受数字、下划线和大小写字母

login

public void login(java.lang.String loginId)

从接口复制的说明: IUserIdentityAPI

登录，设置当前用户的 loginId

指定者:

login 在接口中 IUserIdentityAPI

参数:

loginId - 当前用户的 loginId，不能为空，且长度不能大于 255

login

public void login(java.lang.String loginId,
                  org.json.JSONObject properties)

从接口复制的说明: IUserIdentityAPI

登录，设置当前用户的 loginId

指定者:

login 在接口中 IUserIdentityAPI

参数:

loginId - 当前用户的 loginId，不能为空，且长度不能大于 255

properties - 用户登录属性

logout

public void logout()

从接口复制的说明: IUserIdentityAPI

注销，清空当前用户的 loginId

指定者:

logout 在接口中 IUserIdentityAPI

bind

public void bind(java.lang.String key,
                 java.lang.String value)
          throws InvalidDataException

从接口复制的说明: IUserIdentityAPI

绑定业务 ID

指定者:

bind 在接口中 IUserIdentityAPI

参数:

key - ID

value - 值

抛出:

InvalidDataException - 数据不合法

unbind

public void unbind(java.lang.String key,
                   java.lang.String value)
            throws InvalidDataException

从接口复制的说明: IUserIdentityAPI

解绑业务 ID

指定者:

unbind 在接口中 IUserIdentityAPI

参数:

key - ID

value - 值

抛出:

InvalidDataException - 数据不合法

getIdentities

public org.json.JSONObject getIdentities(EventType eventType)

读取对应的 identities 属性

参数:

eventType - 事件类型

返回:

identities 属性

updateLoginId

public void updateLoginId(java.lang.String loginId)

用于主线程调用 login 时及时更新 LoginId 值

参数:

loginId - LoginId

enableDataCollect

public void enableDataCollect(java.lang.String androidId)

同意隐私权限

参数:

androidId - AndroidId

updateIdentities

public void updateIdentities(org.json.JSONObject identitiesJson)

同意隐私权限时更新默认 ID

参数:

identitiesJson - JSONObject

mergeH5Identities

public void mergeH5Identities(EventType eventType,
                              org.json.JSONObject eventObject)
                       throws InvalidDataException

合并 H5 的 Identities 属性

参数:

eventType - 事件类型

eventObject - 属性

抛出:

InvalidDataException - 数据不合法

loadIdentitiesFromFile

public void loadIdentitiesFromFile()

从本地缓存文件中加载 Identities

isLoginIdValid

public boolean isLoginIdValid(java.lang.String loginId)

是否合法的 LoginId，不等于登录 ID 且不等于匿名 ID，或者 LoginIdKey 发生变化且不等于匿名 ID

参数:

loginId - LoginId

返回:

合法 true，不合法 false