RongUserInfoManager (release 5.1.3.3)

java.lang.Object
- io.rong.imkit.userinfo.RongUserInfoManager

public class RongUserInfoManager
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RongUserInfoManager.UserDataObserver

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RongUserInfoManager.UserDataObserver`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUserDataObserver(RongUserInfoManager.UserDataObserver observer)`
`<any>`	`getAllGroupMembersLiveData()`
`<any>`	`getAllGroupsLiveData()`
`<any>`	`getAllUsersLiveData()`
`UserInfo`	`getCurrentUserInfo()`
`io.rong.imlib.model.Group`	`getGroupInfo(java.lang.String groupId)`
`GroupUserInfo`	`getGroupUserInfo(java.lang.String groupId, java.lang.String userId)`
`static RongUserInfoManager`	`getInstance()`
`UserDatabase`	`getUserDatabase()`
`UserInfo`	`getUserInfo(java.lang.String userId)`
`boolean`	`getUserInfoAttachedState()` 获取当前用户关于消息体内是否携带用户信息的配置
`<any>`	`getUserInfoLiveData(java.lang.String userId)`
`void`	`initAndUpdateUserDataBase(android.content.Context context)` 初始化并打开用户信息数据库
`void`	`refreshGroupInfoCache(io.rong.imlib.model.Group groupInfo)`
`void`	`refreshGroupUserInfoCache(GroupUserInfo groupUserInfo)`
`void`	`refreshUserInfoCache(UserInfo userInfo)`
`void`	`removeUserDataObserver(RongUserInfoManager.UserDataObserver observer)`
`void`	`setCurrentUserInfo(UserInfo userInfo)` 设置当前用户信息。如果开发者没有实现用户信息提供者，而是使用消息携带用户信息，需要使用这个方法设置当前用户的信息，然后在`IMCenter.init(Application, String, boolean)`之后调用`setMessageAttachedUserInfo(boolean)`，这样可以在每条消息中携带当前用户的信息，IMKit会在接收到消息的时候取出用户信息并刷新到界面上。
`void`	`setGroupInfoProvider(UserDataProvider.GroupInfoProvider groupInfoProvider, boolean isCacheGroupInfo)`
`void`	`setGroupUserInfoProvider(UserDataProvider.GroupUserInfoProvider groupUserInfoProvider, boolean isCacheGroupUserInfo)` 设置群成员提供者
`void`	`setMessageAttachedUserInfo(boolean state)` 设置消息体内是否携带用户信息。
`void`	`setUserInfoProvider(UserDataProvider.UserInfoProvider userInfoProvider, boolean isCacheUserInfo)` 设置用户信息的提供者，供 UI 获取用户名称和头像信息。各 ViewModel 会监听用户信息的变化，进行对应刷新。如果需要异步从服务器获取用户信息，使用者可以在此方法中发起异步请求，然后返回 null 信息。在异步请求结果返回后，根据返回的结果调用 `refreshUserInfoCache(UserInfo)`} 刷新用户信息。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static RongUserInfoManager getInstance()
```
  - initAndUpdateUserDataBase
```
public void initAndUpdateUserDataBase(android.content.Context context)
```
    初始化并打开用户信息数据库
    
    Parameters:
    
    context -
  - setUserInfoProvider
```
public void setUserInfoProvider(UserDataProvider.UserInfoProvider userInfoProvider,
                                boolean isCacheUserInfo)
```
    设置用户信息的提供者，供 UI 获取用户名称和头像信息。各 ViewModel 会监听用户信息的变化，进行对应刷新。如果需要异步从服务器获取用户信息，使用者可以在此方法中发起异步请求，然后返回 null 信息。在异步请求结果返回后，根据返回的结果调用 refreshUserInfoCache(UserInfo)} 刷新用户信息。
    
    Parameters:
    
    userInfoProvider - 用户信息提供者 UserDataProvider.UserInfoProvider。
    
    isCacheUserInfo - 设置是否由 IMKit 来缓存用户信息。
    如果 App 提供的 UserInfoProvider。每次都需要通过网络请求用户数据，而不是将用户数据缓存到本地，会影响用户信息的加载速度；
    此时最好将本参数设置为 true，由 IMKit 来缓存用户信息。
  - setGroupInfoProvider
```
public void setGroupInfoProvider(UserDataProvider.GroupInfoProvider groupInfoProvider,
                                 boolean isCacheGroupInfo)
```
  - setGroupUserInfoProvider
```
public void setGroupUserInfoProvider(UserDataProvider.GroupUserInfoProvider groupUserInfoProvider,
                                     boolean isCacheGroupUserInfo)
```
    设置群成员提供者
    
    可以使用此方法，修改群组中用户昵称
    
    设置后，当 sdk 界面展示用户信息时，会回调 UserDataProvider.GroupUserInfoProvider.getGroupUserInfo(String, String) 使用者只需要根据对应的 groupId, userId 提供对应的用户信息 GroupUserInfo。如果需要异步从服务器获取用户信息，使用者可以在此方法中发起异步请求，然后返回 null 信息。在异步请求结果返回后，根据返回的结果调用 refreshGroupUserInfoCache(GroupUserInfo) 刷新信息。
    
    Parameters:
    
    groupUserInfoProvider - 群组用户信息提供者。
    
    isCacheGroupUserInfo - 设置是否由 IMKit 来缓存 GroupUserInfo。
    如果 App 提供的 GroupUserInfoProvider。每次都需要通过网络请求数据，而不是将数据缓存到本地，会影响信息的加载速度；
    此时最好将本参数设置为 true，由 IMKit 来缓存信息。
  - getUserDatabase
```
public UserDatabase getUserDatabase()
```
  - getAllUsersLiveData
```
public <any> getAllUsersLiveData()
```
  - getAllGroupsLiveData
```
public <any> getAllGroupsLiveData()
```
  - getAllGroupMembersLiveData
```
public <any> getAllGroupMembersLiveData()
```
  - getUserInfo
```
public UserInfo getUserInfo(java.lang.String userId)
```
  - getUserInfoLiveData
```
public <any> getUserInfoLiveData(java.lang.String userId)
```
  - getGroupInfo
```
public io.rong.imlib.model.Group getGroupInfo(java.lang.String groupId)
```
  - getGroupUserInfo
```
public GroupUserInfo getGroupUserInfo(java.lang.String groupId,
                                      java.lang.String userId)
```
  - setCurrentUserInfo
```
public void setCurrentUserInfo(UserInfo userInfo)
```
    设置当前用户信息。如果开发者没有实现用户信息提供者，而是使用消息携带用户信息，需要使用这个方法设置当前用户的信息，然后在IMCenter.init(Application, String, boolean)之后调用setMessageAttachedUserInfo(boolean)，这样可以在每条消息中携带当前用户的信息，IMKit会在接收到消息的时候取出用户信息并刷新到界面上。
    
    Parameters:
    
    userInfo - 当前用户信息。
  - getCurrentUserInfo
```
public UserInfo getCurrentUserInfo()
```
  - setMessageAttachedUserInfo
```
public void setMessageAttachedUserInfo(boolean state)
```
    设置消息体内是否携带用户信息。
    
    Parameters:
    
    state - 是否携带用户信息，true 携带，false 不携带。
  - getUserInfoAttachedState
```
public boolean getUserInfoAttachedState()
```
    获取当前用户关于消息体内是否携带用户信息的配置
    
    Returns:
    
    是否携带用户信息
  - refreshUserInfoCache
```
public void refreshUserInfoCache(UserInfo userInfo)
```
  - refreshGroupInfoCache
```
public void refreshGroupInfoCache(io.rong.imlib.model.Group groupInfo)
```
  - refreshGroupUserInfoCache
```
public void refreshGroupUserInfoCache(GroupUserInfo groupUserInfo)
```
  - addUserDataObserver
```
public void addUserDataObserver(RongUserInfoManager.UserDataObserver observer)
```
  - removeUserDataObserver
```
public void removeUserDataObserver(RongUserInfoManager.UserDataObserver observer)
```

Class RongUserInfoManager

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

initAndUpdateUserDataBase

setUserInfoProvider

setGroupInfoProvider

setGroupUserInfoProvider

getUserDatabase

getAllUsersLiveData

getAllGroupsLiveData

getAllGroupMembersLiveData

getUserInfo

getUserInfoLiveData

getGroupInfo

getGroupUserInfo

setCurrentUserInfo

getCurrentUserInfo

setMessageAttachedUserInfo

getUserInfoAttachedState

refreshUserInfoCache

refreshGroupInfoCache

refreshGroupUserInfoCache

addUserDataObserver

removeUserDataObserver