com.netease.nimlib.sdk.uinfo

Interface UserService

public interface UserService

User service interface

Method Summary

Modifier and Type	Method and Description
InvocationFuture<java.util.List<NimUserInfo>>	fetchUserInfo(java.util.List<java.lang.String> accounts) Get user profiles from the app server, 150 user profiles can be fetched per call.
java.util.List<NimUserInfo>	getAllUserInfo() Get all user profiles from the local database.
NimUserInfo	getUserInfo(java.lang.String account) Get a user profile from the local database (sync)
java.util.List<NimUserInfo>	getUserInfoList(java.util.List<java.lang.String> accounts) Get multiple user profiles from the local database (sync)
InvocationFuture<java.util.List<java.lang.String>>	searchAccountByName(java.lang.String name) Search accounts using nicknames
InvocationFuture<java.util.List<NimUserInfo>>	searchUserInfosByKeyword(java.lang.String keyword) Search all users with matched keywords.
InvocationFuture<java.lang.Void>	setUserState(int state)
InvocationFuture<java.lang.Void>	updateUserInfo(java.util.Map<UserInfoFieldEnum,java.lang.Object> fields) Update the user profile of the current user.
InvocationFuture<java.lang.Void>	updateUserInfo(java.util.Map<UserInfoFieldEnum,java.lang.Object> fields, AntiSpamConfig antispamConfig) Update the user profile of the current user.

Method Detail

fetchUserInfo

InvocationFuture<java.util.List<NimUserInfo>> fetchUserInfo(java.util.List<java.lang.String> accounts)

Get user profiles from the app server, 150 user profiles can be fetched per call. If a large number of profiles must be retrieved, the upper layer of the application can handle the profile data by batch

Parameters:

accounts - accounts whose the user profiles are fetched.

Returns:

InvocationFuture Callback If the user profile is stored in the database, the callback will be triggered.

getUserInfoList

java.util.List<NimUserInfo> getUserInfoList(java.util.List<java.lang.String> accounts)

Get multiple user profiles from the local database (sync)

Parameters:

accounts - accounts whose the user profiles are fetched.

Returns:

list of user profiles

getUserInfo

NimUserInfo getUserInfo(java.lang.String account)

Get a user profile from the local database (sync)

Parameters:

account - account whose the user profile is fetched.

Returns:

user profile

getAllUserInfo

java.util.List<NimUserInfo> getAllUserInfo()

Get all user profiles from the local database.

Returns:

all user profiles

updateUserInfo

InvocationFuture<java.lang.Void> updateUserInfo(java.util.Map<UserInfoFieldEnum,java.lang.Object> fields)

Update the user profile of the current user.

Parameters:

fields - The fields to be updated with new values. Key is the field and value is the updated value.

Returns:

InvocationFuture callback

updateUserInfo

InvocationFuture<java.lang.Void> updateUserInfo(java.util.Map<UserInfoFieldEnum,java.lang.Object> fields,
                                                AntiSpamConfig antispamConfig)

Update the user profile of the current user.

Parameters:

fields - The fields to be updated with new values. Key is the field and value is the updated value.

antispamConfig - Anti-spam configuration

Returns:

InvocationFuture callback

setUserState

InvocationFuture<java.lang.Void> setUserState(int state)

searchUserInfosByKeyword

InvocationFuture<java.util.List<NimUserInfo>> searchUserInfosByKeyword(java.lang.String keyword)

Search all users with matched keywords.

Returns:

Users

searchAccountByName

InvocationFuture<java.util.List<java.lang.String>> searchAccountByName(java.lang.String name)

Search accounts using nicknames

Parameters:

name - Nickname

Returns:

account