BIMClient

public class com.bytedance.im.core.api.BIMClient
java

IM SDK 对外接口类，通过此类提供所有 IM SDK 能力接口。

静态函数

返回	名称
static BIMClient	getInstance

成员函数

返回	名称
boolean	initSDK
void	unInitSDK
void	login
void	logout
void	addConnectListener
void	removeConnectListener
long	getCurrentUserID
String	getToken
String	getVersion
long	getVersionCode
BIMConnectStatus	getConnectStatus
Long	getServerTime
int	getAppID
void	getConversationList
void	getConversation
void	addConversationListener
void	removeConversationListener
void	createGroupConversation
void	getConversationMemberList
void	addGroupMemberList
void	removeGroupMemberList
void	setGroupMemberRole
void	dissolveGroup
void	leaveGroup
void	setGroupName
void	setGroupNotice
void	createSingleConversation
void	deleteConversation
void	deleteConversation
void	markConversationRead
void	stickTopConversation
void	muteConversation
void	setConversationDraft
void	getHistoryMessageList
void	getNewerMessageList
void	getMessage
void	sendMessage
void	addLocalMessage
void	addMessageListener
void	removeMessageListener
void	deleteMessage
void	deleteLocalMessage
void	recallMessage
BIMMessage	createTextMessage
BIMMessage	createTextMessage
BIMMessage	createTextMessage
BIMMessage	createAudioMessage
BIMMessage	createImageMessage
BIMMessage	createVideoMessage
BIMMessage	createFileMessage
BIMMessage	createCustomMessage
void	getTotalUnreadMessageCount
void	refreshMediaMessage
void	getSDKDid

函数说明

getInstance

public static BIMClient com.bytedance.im.core.api.BIMClient.getInstance()
java

获取 BIMClient 单例

返回值
BIMClient 单例

initSDK

public boolean com.bytedance.im.core.api.BIMClient.initSDK(
    Application app,
    int appId,
    BIMSDKConfig config)
java

初始化 SDK。

传入参数

参数名	类型	说明
app	Application	应用 Application 实例。
appId	int	从控制台获取的应用 ID。不同应用 ID 无法进行互通。
config	BIMSDKConfig	配置信息，参看 BIMSDKConfig。

unInitSDK

public void com.bytedance.im.core.api.BIMClient.unInitSDK()
java

注销 SDK, 释放内存缓存资源、注销监听等。

public void com.bytedance.im.core.api.BIMClient.login(
    final long uid,
    final String token,
    final BIMSimpleCallback callback)
java

登录服务器。

传入参数

参数名	类型	说明
uid	final long	用户 ID。
token	final String	用户 Token。
callback	final BIMSimpleCallback	登录结果回调，参看 BIMSimpleCallback。

logout

public void com.bytedance.im.core.api.BIMClient.logout()
java

登出服务器。

addConnectListener

public void com.bytedance.im.core.api.BIMClient.addConnectListener(
    final BIMConnectListener listener)
java

设置长链状态监听。

传入参数

参数名	类型	说明
listener	final BIMConnectListener	长链状态监听方，参看 BIMConnectListener。

removeConnectListener

public void com.bytedance.im.core.api.BIMClient.removeConnectListener(
    final BIMConnectListener listener)
java

设置长链状态监听。

传入参数

参数名	类型	说明
listener	final BIMConnectListener	长链状态监听方，参看 BIMConnectListener。

getCurrentUserID

public long com.bytedance.im.core.api.BIMClient.getCurrentUserID()
java

获取当前用户 ID。

返回值
用户 ID。

getToken

public String com.bytedance.im.core.api.BIMClient.getToken()
java

获取当前用户 Token。

返回值
用户 Token。

getVersion

public String com.bytedance.im.core.api.BIMClient.getVersion()
java

获取 SDK 版本号名称。

返回值
SDK 版本号名称。

getVersionCode

public long com.bytedance.im.core.api.BIMClient.getVersionCode()
java

获取 SDK 版本号。

返回值
SDK 版本号。

getConnectStatus

public BIMConnectStatus com.bytedance.im.core.api.BIMClient.getConnectStatus()
java

获取连接状态。

返回值
连接状态。

getServerTime

public Long com.bytedance.im.core.api.BIMClient.getServerTime()
java

获取服务端时间。

返回值
服务端时间戳，单位为毫秒。

getAppID

public int com.bytedance.im.core.api.BIMClient.getAppID()
java

获取当前 appID。

返回值
当前 appID

getConversationList

public void com.bytedance.im.core.api.BIMClient.getConversationList(
    long cursor,
    int count,
    BIMResultCallback<BIMConversationListResult> callback)
java

获取会话列表。

传入参数

参数名	类型	说明
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 100 个会话。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversationListResult。

注意

历史会话数量可能很多，因此建议采用分页查询的方式进行接口调用。
该接口拉取的是本地缓存的会话。若服务器会话有更新，SDK 内部会自动同步，并通过 BIMResultCallback 回调告知用户。
如果会话全部拉取完毕，结果回调 BIMResultCallback 中的 hasMore 获取字段值为 false。

getConversation

public void com.bytedance.im.core.api.BIMClient.getConversation(
    String conversationId,
    BIMResultCallback<BIMConversation> callback)
java

获取指定单个会话。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversation。

addConversationListener

public void com.bytedance.im.core.api.BIMClient.addConversationListener(
    BIMConversationListListener listener)
java

添加会话监听。

传入参数

参数名	类型	说明
listener	BIMConversationListListener	会话监听方，参看 BIMConversationListListener。

removeConversationListener

public void com.bytedance.im.core.api.BIMClient.removeConversationListener(
    BIMConversationListListener listener)
java

移除会话监听。

传入参数

参数名	类型	说明
listener	BIMConversationListListener	会话监听方，参看 BIMConversationListListener。

createGroupConversation

public void com.bytedance.im.core.api.BIMClient.createGroupConversation(
    List<Long> uidList,
    BIMResultCallback<BIMConversation> callback)
java

创建群聊。

传入参数

参数名	类型	说明
uidList	List	用户 ID 列表。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversation。

getConversationMemberList

public void com.bytedance.im.core.api.BIMClient.getConversationMemberList(
    String conversationId,
    BIMResultCallback<List<BIMMember>> callback)
java

获取群成员。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
callback	BIMResultCallback<List>	群成员列表回调，参看 BIMResultCallback, BIMMember。

addGroupMemberList

public void com.bytedance.im.core.api.BIMClient.addGroupMemberList(
    String conversationId,
    List<Long> ids,
    BIMSimpleCallback callback)
java

添加群成员。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
ids	List	待添加的群成员 ID 列表。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

removeGroupMemberList

public void com.bytedance.im.core.api.BIMClient.removeGroupMemberList(
    String conversationId,
    List<Long> ids,
    BIMSimpleCallback callback)
java

移除群成员。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
ids	List	待移除的群成员 ID 列表。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setGroupMemberRole

public void com.bytedance.im.core.api.BIMClient.setGroupMemberRole(
    String conversationId,
    List<Long> uidList,
    BIMMemberRole role,
    BIMSimpleCallback callback)
java

设置群成员角色。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
uidList	List	群成员 ID 列表。
role	BIMMemberRole	群组角色，参看。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

dissolveGroup

public void com.bytedance.im.core.api.BIMClient.dissolveGroup(
    String conversationId,
    boolean isDeleteLocal,
    BIMSimpleCallback callback)
java

解散群组。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
isDeleteLocal	boolean	是否在本地删除。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

leaveGroup

public void com.bytedance.im.core.api.BIMClient.leaveGroup(
    String conversationId,
    boolean isDeleteServer,
    BIMSimpleCallback callback)
java

离开群组。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
isDeleteServer	boolean	是否在服务器删除。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setGroupName

public void com.bytedance.im.core.api.BIMClient.setGroupName(
    String conversationId,
    String name,
    BIMSimpleCallback callback)
java

设置群组名称。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
name	String	群组名称。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setGroupNotice

public void com.bytedance.im.core.api.BIMClient.setGroupNotice(
    String conversationId,
    String notice,
    BIMSimpleCallback callback)
java

设置群公告。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
notice	String	群公告内容。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

createSingleConversation

public void com.bytedance.im.core.api.BIMClient.createSingleConversation(
    long toUid,
    BIMResultCallback<BIMConversation> callback)
java

创建单聊会话。

传入参数

参数名	类型	说明
toUid	long	对方用户 ID。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversation。

deleteConversation

public void com.bytedance.im.core.api.BIMClient.deleteConversation(
    long toUid,
    BIMSimpleCallback callback)
java

通过用户 ID 删除会话。

传入参数

参数名	类型	说明
toUid	long	对方用户 ID。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

注意
调用本接口后，SDK 会从本地和服务端删除该会话及会话中的历史消息，且不可恢复。

deleteConversation

public void com.bytedance.im.core.api.BIMClient.deleteConversation(
    String conversationId,
    BIMSimpleCallback callback)
java

通过会话 ID 删除会话。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

注意
调用本接口后，SDK 会从本地和服务端删除该会话及会话中的历史消息，且不可恢复。

markConversationRead

public void com.bytedance.im.core.api.BIMClient.markConversationRead(
    String conversationId,
    BIMSimpleCallback callback)
java

标记会话已读。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。

stickTopConversation

public void com.bytedance.im.core.api.BIMClient.stickTopConversation(
    String conversationId,
    boolean isStickTop,
    BIMSimpleCallback callback)
java

置顶会话。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
isStickTop	boolean	是否置顶。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

muteConversation

public void com.bytedance.im.core.api.BIMClient.muteConversation(
    String conversationId,
    boolean isMute,
    BIMSimpleCallback callback)
java

设置会话免打扰。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
isMute	boolean	是否免打扰。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setConversationDraft

public void com.bytedance.im.core.api.BIMClient.setConversationDraft(
    String draft,
    String conversationId)
java

设置会话草稿。

传入参数

参数名	类型	说明
draft	String	草稿内容。
conversationId	String	会话 ID。

getHistoryMessageList

public void com.bytedance.im.core.api.BIMClient.getHistoryMessageList(
    String conversationId,
    BIMGetMessageOption option,
    BIMResultCallback<BIMMessageListResult> callback)
java

获取历史消息（锚点之前的消息），返回消息顺序从新到旧。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
option	BIMGetMessageOption	获取消息选项，参看 BIMGetMessageOption。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessageListResult。

getNewerMessageList

public void com.bytedance.im.core.api.BIMClient.getNewerMessageList(
    String conversationId,
    BIMGetMessageOption option,
    BIMResultCallback<BIMMessageListResult> callback)
java

获取历史消息（锚点之后的消息），返回消息顺序从旧到新。

传入参数

参数名	类型	说明
conversationId	String	会话 ID。
option	BIMGetMessageOption	获取消息选项，参看 BIMGetMessageOption。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessageListResult。

getMessage

public void com.bytedance.im.core.api.BIMClient.getMessage(
    String uuid,
    BIMResultCallback<BIMMessage> callback)
java

返回查询到的消息。

传入参数

参数名	类型	说明
uuid	String	消息客户端 Id
callback	BIMResultCallback	结果回调,参看 BIMResultCallback,BIMMessage

sendMessage

public void com.bytedance.im.core.api.BIMClient.sendMessage(
    final BIMMessage message,
    String conversationId,
    BIMSendCallback callback)
java

发送消息。
目前仅支持直接发送普通文本消息，发送图片消息、视频消息、语音消息、文件消息前请联系技术支持同学进行配置。

传入参数

参数名	类型	说明
message	final BIMMessage	消息体，由 `createXxxMessage` 接口创建，参看 BIMMessage。
conversationId	String	会话 ID。
callback	BIMSendCallback	发送结果回调，参看 BIMSendCallback。

addLocalMessage

public void com.bytedance.im.core.api.BIMClient.addLocalMessage(
    final BIMMessage message,
    String conversationId,
    BIMResultCallback<BIMMessage> callback)
java

添加消息到本地。

传入参数

参数名	类型	说明
message	final BIMMessage	待添加的消息，参看 BIMMessage。
conversationId	String	会话 ID。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

addMessageListener

public void com.bytedance.im.core.api.BIMClient.addMessageListener(
    BIMMessageListener listener)
java

设置消息监听。

传入参数

参数名	类型	说明
listener	BIMMessageListener	消息监听方，参看 BIMMessageListener。

removeMessageListener

public void com.bytedance.im.core.api.BIMClient.removeMessageListener(
    BIMMessageListener listener)
java

移除消息监听。

传入参数

参数名	类型	说明
listener	BIMMessageListener	消息监听方，参看 BIMMessageListener。

deleteMessage

public void com.bytedance.im.core.api.BIMClient.deleteMessage(
    BIMMessage bimMessage,
    BIMResultCallback<BIMMessage> callback)
java

删除本地和服务端消息。

传入参数

参数名	类型	说明
bimMessage	BIMMessage	待删除的消息，参看 BIMMessage。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

deleteLocalMessage

public void com.bytedance.im.core.api.BIMClient.deleteLocalMessage(
    BIMMessage message,
    BIMResultCallback<BIMMessage> callback)
java

删除本地消息。

传入参数

参数名	类型	说明
message	BIMMessage	待删除的消息，参看 BIMMessage。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

recallMessage

public void com.bytedance.im.core.api.BIMClient.recallMessage(
    BIMMessage message,
    final BIMResultCallback<BIMMessage> callback)
java

撤回消息。

传入参数

参数名	类型	说明
message	BIMMessage	待撤回的消息，参看 BIMMessage。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

createTextMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createTextMessage(
    String text)
java

创建文本消息。

传入参数

参数名	类型	说明
text	String	消息文本。

返回值
消息体，参看 BIMMessage。

createTextMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createTextMessage(
    String text,
    List<Long> uidList)
java

创建带 @ 标记的消息。

传入参数

参数名	类型	说明
text	String	消息文本。
uidList	List	需要 @ 的用户列表。

返回值
消息体，参看 BIMMessage。

注意
仅可在群组中发送带 @ 标记的消息。

createTextMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createTextMessage(
    String text,
    List<Long> atUidList,
    BIMMessage refMessage,
    String hint)
java

创建带引用消息的文本消息。

传入参数

参数名	类型	说明
text	String	消息文本。
atUidList	List	需要 @ 的用户列表。
refMessage	BIMMessage	引用的消息，参看 BIMMessage。
hint	String	业务透传引用信息。

返回值
消息体，参看 BIMMessage。

createAudioMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createAudioMessage(
    String path)
java

创建语音消息。

传入参数

参数名	类型	说明
path	String	音频路径。

返回值
消息体，参看 BIMMessage。

createImageMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createImageMessage(
    String path)
java

创建图片消息。

传入参数

参数名	类型	说明
path	String	图片路径。

返回值
消息体，参看 BIMMessage。

注意
若图片来自系统相册，需要先把图片导入 App 目录下。

createVideoMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createVideoMessage(
    String path)
java

创建视频消息。

传入参数

参数名	类型	说明
path	String	视频路径。

返回值
消息体，参看 BIMMessage。

注意
若视频来自系统相册，需要先把视频导入 App 目录下。

createFileMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createFileMessage(
    Uri uri,
    String path,
    String fileName,
    long length)
java

创建文件消息。

传入参数

参数名	类型	说明
uri	Uri	文件 URI。
path	String	文件路径。
fileName	String	文件名称。
length	long	文件大小。

返回值
消息体，参看 BIMMessage。

createCustomMessage

public BIMMessage com.bytedance.im.core.api.BIMClient.createCustomMessage(
    String data)
java

创建自定义消息。

传入参数

参数名	类型	说明
data	String	自定义参数。

返回值
消息体，参看 BIMMessage。

getTotalUnreadMessageCount

public void com.bytedance.im.core.api.BIMClient.getTotalUnreadMessageCount(
    BIMResultCallback<BIMUnReadInfo> callback)
java

获取所有会话的未读消息总数。

传入参数

参数名	类型	说明
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMUnReadInfo。

注意
会话未读消息不包括设置为免打扰会话中的未读消息。

refreshMediaMessage

public void com.bytedance.im.core.api.BIMClient.refreshMediaMessage(
    BIMMessage bimMessage,
    BIMResultCallback<BIMMessage> callback)
java

刷新媒体信息，媒体 URL 过期时调用该方法。

传入参数

参数名	类型	说明
bimMessage	BIMMessage	消息体，参看 BIMMessage。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

getSDKDid

public void com.bytedance.im.core.api.BIMClient.getSDKDid(
    BIMResultCallback<String> callback)
java

获取设备 did。

返回值
设备 did。

BIMLiveExpandService

public class com.bytedance.im.live.BIMLiveExpandService
java

IM SDK 直播群对外接口类，通过此类提供所有直播群能力接口。
获取实例方式 BIMClient.getInstance().getService(BIMLiveExpandService.class)，参看 BIMClient，直播群不提供本地数据存储。

成员函数

返回	名称
void	getOwnerLiveGroupList
void	getAllLiveGroupList
void	getLiveGroup
void	getLiveGroupHistoryMessageList
void	getLiveGroupOnLineCount
void	createLiveGroup
void	joinLiveGroup
void	addLiveGroupMessageListener
void	removeLiveGroupMessageListener
void	addLiveConversationListener
void	removeLiveConversationListener
void	addLiveGroupMemberListener
void	removeLiveGroupMemberListener
void	leaveLiveGroup
void	dissolveLiveGroup
void	getLiveGroupMemberOnlineList
void	getLiveGroupMemberList
void	getLiveGroupMemberSilentWhiteList
void	addLiveGroupMemberSilentWhiteList
void	removeLiveGroupMemberSilentWhiteList
void	getLiveGroupMemberBlockList
void	addLiveGroupMemberBlockList
void	removeLiveGroupMemberBlockList
void	getLiveGroupMemberSilentList
void	setLiveGroupSilent
void	addLiveGroupMemberSilentList
void	removeLiveGroupMemberSilentList
void	kickLiveGroupMemberList
void	transLiveGroupOwner
void	addLiveGroupAdmin
void	removeLiveGroupAdmin
void	setLiveGroupMemberRole
void	setLiveGroupMemberInfo
void	setLiveGroupMemberAlias
void	setLiveGroupMemberAvatar
void	addLiveGroupMemberExt
void	joinLiveGroup
void	getLiveGroupMemberInfo
void	setLiveGroupNotice
void	setLiveGroupDescription
void	setLiveGroupName
void	setLiveGroupIcon
void	sendLiveGroupMessage
void	sendLiveGroupMessage
void	getLiveGroupMemberOnlineInfo
void	refreshLiveGroupMediaMessage
void	manageLiveGroupMarkTypes
void	addLiveGroupMarkTypeListener
void	removeLiveGroupMarkTypeListener
void	markLiveGroupMemberList
void	getLiveGroupMarkTypeList
void	getLiveGroupMemberOnlineList

函数说明

getOwnerLiveGroupList

public void com.bytedance.im.live.BIMLiveExpandService.getOwnerLiveGroupList(
    long cursor,
    int count,
    final BIMResultCallback<BIMLiveGroupListResult> callback)
java

获取我是群主的直播群列表。

传入参数

参数名	类型	说明
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个会话。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveGroupListResult。

getAllLiveGroupList

public void com.bytedance.im.live.BIMLiveExpandService.getAllLiveGroupList(
    long cursor,
    int count,
    final BIMResultCallback<BIMLiveGroupListResult> callback)
java

获取当前应用下的所有直播群列表。

传入参数

参数名	类型	说明
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个会话。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveGroupListResult。

getLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroup(
    long conversationShortId,
    final BIMResultCallback<BIMConversation> callback)
java

获取直播群信息。

传入参数

参数名	类型	说明
conversationShortId	long	直播群会话 shortId。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversation。

getLiveGroupHistoryMessageList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupHistoryMessageList(
    long conversationShortId,
    long cursor,
    long limit,
    final BIMResultCallback<BIMLiveMessageListResult> callback)
java

获取直播群历史消息(从新到旧)。

传入参数

参数名	类型	说明
conversationShortId	long	直播群会话 shortId。
cursor	long	直播群历史消息拉取起点
callback	final BIMResultCallback	获取直播群历史消息，参看 BIMResultCallback,BIMLiveMessageListResult。

getLiveGroupOnLineCount

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupOnLineCount(
    long conversationShortId,
    final BIMResultCallback<Long> callback)
java

获取直播群在线人数。

传入参数

参数名	类型	说明
conversationShortId	long	直播群会话 shortId。
callback	final BIMResultCallback	在线人数结果回调，参看 BIMResultCallback。

createLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.createLiveGroup(
    BIMGroupInfo groupInfo,
    final BIMResultCallback<BIMConversation> callback)
java

创建直播群。

传入参数

参数名	类型	说明
groupInfo	BIMGroupInfo	创建直播群参数信息，包括名称，头像等，参看 BIMGroupInfo
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversation。

joinLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.joinLiveGroup(
    final long conversationShortId,
    final BIMResultCallback<BIMLiveJoinGroupResult> callback)
java

加入直播群，加入直播群后可以收发当前群的信息，直播群不提供本地存储。

传入参数

参数名	类型	说明
conversationShortId	final long	直播群 ShortId。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveJoinGroupResult。

addLiveGroupMessageListener

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMessageListener(
    BIMLiveMessageListener listener)
java

设置直播群消息监听。

传入参数

参数名	类型	说明
listener	BIMLiveMessageListener	直播群消息事件回调监听方，参看 BIMLiveMessageListener。

removeLiveGroupMessageListener

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMessageListener(
    BIMLiveMessageListener listener)
java

设置直播群消息监听。

传入参数

参数名	类型	说明
listener	BIMLiveMessageListener	直播群消息事件回调监听方，参看 BIMLiveMessageListener。

addLiveConversationListener

public void com.bytedance.im.live.BIMLiveExpandService.addLiveConversationListener(
    BIMLiveConversationListener listener)
java

设置直播群会话监听。

传入参数

参数名	类型	说明
listener	BIMLiveConversationListener	直播群会话事件回调监听方，参看 BIMLiveConversationListener。

removeLiveConversationListener

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveConversationListener(
    BIMLiveConversationListener listener)
java

移除直播群会话监听。

传入参数

参数名	类型	说明
listener	BIMLiveConversationListener	直播群会话事件回调监听方，参看 BIMLiveConversationListener。

addLiveGroupMemberListener

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMemberListener(
    BIMLiveGroupMemberEventListener listener)
java

设置直播群成员监听。

传入参数

参数名	类型	说明
listener	BIMLiveGroupMemberEventListener	直播群成员事件回调监听方，参看 BIMLiveGroupMemberEventListener。

removeLiveGroupMemberListener

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMemberListener(
    BIMLiveGroupMemberEventListener listener)
java

移除直播群成员监听。

传入参数

参数名	类型	说明
listener	BIMLiveGroupMemberEventListener	直播群成员事件回调监听方，参看 BIMLiveGroupMemberEventListener。

leaveLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.leaveLiveGroup(
    long conversationShortId,
    BIMSimpleCallback callback)
java

离开直播群。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
callback	BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

dissolveLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.dissolveLiveGroup(
    long conversationShortId,
    final BIMSimpleCallback callback)
java

解散直播群，仅群主可操作。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

getLiveGroupMemberOnlineList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberOnlineList(
    long conversationShortId,
    long cursor,
    long count,
    final BIMResultCallback<BIMLiveMemberListResult> callback)
java

获取直播群在线用户列表。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveMemberListResult。

getLiveGroupMemberList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberList(
    long conversationShortId,
    long cursor,
    long count,
    final BIMResultCallback<BIMLiveMemberListResult> callback)
java

获取直播群群主管理员等常驻成员列表。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveMemberListResult。

getLiveGroupMemberSilentWhiteList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberSilentWhiteList(
    long conversationShortId,
    long cursor,
    long count,
    final BIMResultCallback<BIMLiveMemberListResult> callback)
java

获取会话禁言白名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveMemberListResult。

addLiveGroupMemberSilentWhiteList

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMemberSilentWhiteList(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

添加禁言会话白名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	成员列表
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

removeLiveGroupMemberSilentWhiteList

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMemberSilentWhiteList(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

移除禁言会话白名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	成员列表
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

getLiveGroupMemberBlockList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberBlockList(
    long conversationShortId,
    long cursor,
    long count,
    BIMResultCallback<BIMLiveMemberListResult> callback)
java

获取直播群进群黑名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback,BIMLiveMemberListResult。

addLiveGroupMemberBlockList

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMemberBlockList(
    long conversationShortId,
    List<Long> uidList,
    long blockTime,
    final BIMSimpleCallback callback)
java

添加群进群黑名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	待加入禁言成员 UID 列表。
blockTime	long	禁言时间(绝对时间), 单位: 秒(s)
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

removeLiveGroupMemberBlockList

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMemberBlockList(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

添加群进群黑名单。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	待移出禁言成员 UID 列表。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

getLiveGroupMemberSilentList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberSilentList(
    long conversationShortId,
    long cursor,
    long count,
    BIMResultCallback<BIMLiveMemberListResult> callback)
java

获取直播群禁言用户列表。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	BIMResultCallback	结果回调，参看 BIMResultCallback,BIMLiveMemberListResult。

setLiveGroupSilent

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupSilent(
    long conversationShortId,
    boolean isSilent,
    final BIMSimpleCallback callback)
java

设置会话禁言(所有成员禁言)。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
isSilent	boolean	禁言设置为 true、取消禁言设置为 false。
callback	final BIMSimpleCallback	结果回调，参看 BIMResultCallback, BIMLiveMemberListResult。

addLiveGroupMemberSilentList

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMemberSilentList(
    long conversationShortId,
    List<Long> uidList,
    long blockTime,
    final BIMSimpleCallback callback)
java

添加群成员禁言。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	待添加禁言成员 UID 列表。
blockTime	long	禁言时间(绝对时间), 单位: 秒(s)
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

removeLiveGroupMemberSilentList

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMemberSilentList(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

移出群成员禁言。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	待添加禁言成员 UID 列表。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

kickLiveGroupMemberList

public void com.bytedance.im.live.BIMLiveExpandService.kickLiveGroupMemberList(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

踢出在线成员。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	踢出成员 UID 列表。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

transLiveGroupOwner

public void com.bytedance.im.live.BIMLiveExpandService.transLiveGroupOwner(
    long conversationShortId,
    long uid,
    final BIMSimpleCallback callback)
java

转让群主。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uid	long	转让群主用户 ID。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

addLiveGroupAdmin

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupAdmin(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

设置直播群管理员。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	设置群管理员列表
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

removeLiveGroupAdmin

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupAdmin(
    long conversationShortId,
    List<Long> uidList,
    final BIMSimpleCallback callback)
java

移除直播群管理员。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	移除群管理员列表
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupMemberRole

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupMemberRole(
    long conversationShortId,
    List<Long> uidList,
    BIMMemberRole role,
    final BIMSimpleCallback callback)
java

设置成员角色。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	设置成员列表
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupMemberInfo

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupMemberInfo(
    long conversationShortId,
    MemberUpdateInfo memberInfo,
    final BIMSimpleCallback callback)
java

设置直播群成员信息，覆盖服务端存储。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
memberInfo	MemberUpdateInfo	设置当前用户成员信息，参看 MemberUpdateInfo。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

注意
成员信息与用户信息不同，用户在不同直播群可以拥有不同的成员信息，退群后信息自动销毁。

setLiveGroupMemberAlias

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupMemberAlias(
    long conversationShortId,
    String alias,
    final BIMSimpleCallback callback)
java

设置直播群成员昵称。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
alias	String	设置当前用户成员昵称。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupMemberAvatar

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupMemberAvatar(
    long conversationShortId,
    String avatarUrl,
    final BIMSimpleCallback callback)
java

设置直播群成员头像。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
avatarUrl	String	设置当前用户成员头像 URL。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

addLiveGroupMemberExt

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMemberExt(
    long conversationShortId,
    Map<String,String> ext,
    final BIMSimpleCallback callback)
java

设置直播群成员自定义信息，相同 key 会覆盖。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
ext	Map<String,String>	设置直播群成员自定义信息。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

joinLiveGroup

public void com.bytedance.im.live.BIMLiveExpandService.joinLiveGroup(
    final long conversationShortId,
    MemberUpdateInfo memberInfo,
    final BIMResultCallback<BIMLiveJoinGroupResult> callback)
java

加入直播群并设置当前用户成员信息。

传入参数

参数名	类型	说明
conversationShortId	final long	直播群 ShortId。
memberInfo	MemberUpdateInfo	当前用户成员信息，参看 MemberUpdateInfo。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveJoinGroupResult。

注意

同一时间只能进入一个直播群，直播群不提供本地存储。
成员信息与用户信息不同，用户在不同直播群可以拥有不同的成员信息，退群后信息自动销毁。

getLiveGroupMemberInfo

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberInfo(
    long conversationShortId,
    long uid,
    final BIMResultCallback<BIMMember> callback)
java

获取直播群成员信息，其中包括当前在直播群的成员以及群主管理员，退出群的游客信息无法获取。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uid	long	直播群成员 uid
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveJoinGroupResult。

setLiveGroupNotice

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupNotice(
    long conversationShortId,
    String notice,
    final BIMSimpleCallback callback)
java

设置群公告。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
notice	String	群公告。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupDescription

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupDescription(
    long conversationShortId,
    String description,
    final BIMSimpleCallback callback)
java

设置群描述。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
description	String	群描述。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupName

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupName(
    long conversationShortId,
    String name,
    final BIMSimpleCallback callback)
java

设置群名称。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
name	String	群名称。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

setLiveGroupIcon

public void com.bytedance.im.live.BIMLiveExpandService.setLiveGroupIcon(
    long conversationShortId,
    String url,
    final BIMSimpleCallback callback)
java

设置群头像。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
url	String	群头像 URL。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

sendLiveGroupMessage

public void com.bytedance.im.live.BIMLiveExpandService.sendLiveGroupMessage(
    final BIMMessage message,
    BIMConversation conversation,
    final BIMSendCallback callback)
java

发送直播群消息。
目前仅支持直接发送普通文本消息，发送图片消息、视频消息、语音消息、文件消息前请联系技术支持同学进行配置。

传入参数

参数名	类型	说明
message	final BIMMessage	发送的消息体，参看 BIMMessage。
conversation	BIMConversation	会话信息, 参看 BIMConversation
callback	final BIMSendCallback	结果回调，参看 BIMSendCallback。

注意
若需要为消息设置优先级，请调用 sendLiveGroupMessage。

sendLiveGroupMessage

public void com.bytedance.im.live.BIMLiveExpandService.sendLiveGroupMessage(
    final BIMMessage message,
    BIMConversation conversation,
    BIMMessagePriority priority,
    final BIMSendCallback callback)
java

发送直播群消息。

传入参数

参数名	类型	说明
message	final BIMMessage	发送的消息体，参看 BIMMessage。
conversation	BIMConversation	会话信息，参看 BIMConversation。
priority	BIMMessagePriority	设置消息优先级，参看 BIMMessagePriority。
callback	final BIMSendCallback	结果回调，参看 BIMSendCallback。

getLiveGroupMemberOnlineInfo

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberOnlineInfo(
    long conversationId,
    List<Long> uidList,
    final BIMResultCallback<List<BIMLiveMemberOnlineInfo>> callback)
java

获取直播群成员在线信息。

传入参数

参数名	类型	说明
conversationId	long	会话 ID。
uidList	List	成员 ID 列表。
callback	final BIMResultCallback<List>	结果回调，参看 BIMLiveMemberOnlineInfo

refreshLiveGroupMediaMessage

public void com.bytedance.im.live.BIMLiveExpandService.refreshLiveGroupMediaMessage(
    final BIMMessage bimMessage,
    final BIMResultCallback<BIMMessage> callback)
java

刷新直播群媒体信息，媒体 URL 过期时调用该方法。

传入参数

参数名	类型	说明
bimMessage	final BIMMessage	消息体，参看 BIMMessage。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMMessage。

manageLiveGroupMarkTypes

public void com.bytedance.im.live.BIMLiveExpandService.manageLiveGroupMarkTypes(
    long conversationShortId,
    BIMLiveGroupMarkTypeAction action,
    List<String> markTypeList,
    final BIMSimpleCallback callback)
java

管理群成员标记类型。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
action	BIMLiveGroupMarkTypeAction	标记变更类型，参看 BIMLiveGroupMarkTypeAction。
markTypeList	List	标记列表。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

addLiveGroupMarkTypeListener

public void com.bytedance.im.live.BIMLiveExpandService.addLiveGroupMarkTypeListener(
    BIMLiveGroupMarkTypeListener listener)
java

新增直播群标记事件监听。

传入参数

参数名	类型	说明
listener	BIMLiveGroupMarkTypeListener	直播群标记事件回调监听方，参看 BIMLiveGroupMarkTypeListener。

removeLiveGroupMarkTypeListener

public void com.bytedance.im.live.BIMLiveExpandService.removeLiveGroupMarkTypeListener(
    BIMLiveGroupMarkTypeListener listener)
java

移除直播群标记事件监听。

传入参数

参数名	类型	说明
listener	BIMLiveGroupMarkTypeListener	直播群标记事件回调监听方，参看 BIMLiveGroupMarkTypeListener。

markLiveGroupMemberList

public void com.bytedance.im.live.BIMLiveExpandService.markLiveGroupMemberList(
    long conversationShortId,
    List<Long> uidList,
    BIMLiveGroupMarkTypeAction action,
    List<String> markTypeList,
    final BIMResultCallback<List<BIMLiveGroupMarkMemberFailedInfo>> callback)
java

标记群成员。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
uidList	List	成员列表。
action	BIMLiveGroupMarkTypeAction	标记变更类型，参看 BIMLiveGroupMarkTypeAction。
markTypeList	List	标记列表
callback	final BIMResultCallback<List>	结果回调，参看 BIMResultCallback, BIMLiveGroupMarkMemberFailedInfo

getLiveGroupMarkTypeList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMarkTypeList(
    long conversationShortId,
    final BIMResultCallback<List<String>> callback)
java

获取群聊标记类型列表。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
callback	final BIMResultCallback<List>	结果回调，参看 BIMResultCallback.

getLiveGroupMemberOnlineList

public void com.bytedance.im.live.BIMLiveExpandService.getLiveGroupMemberOnlineList(
    long conversationShortId,
    long cursor,
    long count,
    String markType,
    final BIMResultCallback<BIMLiveMemberListResult> callback)
java

根据标记获取直播群在线用户列表。
支持拉取近 1000 个在线游客。

传入参数

参数名	类型	说明
conversationShortId	long	直播群 ShortId。
markType	String	标记类型。
cursor	long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	long	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 成员。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMLiveMemberListResult。

BIMContactExpandService

public class com.bytedance.im.user.BIMContactExpandService
java

IM SDK 联系人对外接口类，通过此类提供所有联系人能力接口。

成员函数

返回	名称
void	getFriendApplyList
void	getFriendList
void	applyFriend
void	deleteFriend
void	replyFriendApply
void	markFriendApplyRead
void	addFriendListener
void	getFriendApplyUnreadCount
boolean	removeFriendListener
void	addToBlackList
void	deleteFromBlackList
void	checkUserInBlackList
void	getBlackList
void	getBlackList
void	updateFriendAlias
void	getUserFullInfo
void	getUserFullInfo
void	getUserFullInfoList
void	getUserFullInfoList
void	setUserSelfPortrait
void	setUserSelfNickName
void	setUserSelfExt
void	updateUserSelfProfile
void	addFriendConversationListener
void	getFriendConversationList
void	getFriendConversationListTotalUnreadCount
void	removeFriendConversationListener

函数说明

getFriendApplyList

public void com.bytedance.im.user.BIMContactExpandService.getFriendApplyList(
    long cursor,
    long limit,
    final BIMResultCallback<BIMFriendApplyListResult> callback)
java

获取好友申请列表，按发起申请的时间排序（从新到旧）。

传入参数

参数名	类型	说明
cursor	long	游标，首页拉取可使用 0。
limit	long	查询条数。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMFriendApplyListResult。

getFriendList

public void com.bytedance.im.user.BIMContactExpandService.getFriendList(
    final BIMResultCallback<List<BIMUserFullInfo>> callback)
java

获取好友列表（全量）。

传入参数

参数名	类型	说明
callback	final BIMResultCallback<List>	结果回调，参看 BIMResultCallback, BIMUserFullInfo。

applyFriend

public void com.bytedance.im.user.BIMContactExpandService.applyFriend(
    final BIMApplyInfo applyInfo,
    final BIMResultCallback<BIMFriendApplyInfo> callback)
java

申请添加好友。

传入参数

参数名	类型	说明
applyInfo	final BIMApplyInfo	申请信息，参看 BIMApplyInfo。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMFriendApplyInfo。

deleteFriend

public void com.bytedance.im.user.BIMContactExpandService.deleteFriend(
    long uid,
    final BIMSimpleCallback callback)
java

删除好友。

传入参数

参数名	类型	说明
uid	long	联系人用户 ID。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

replyFriendApply

public void com.bytedance.im.user.BIMContactExpandService.replyFriendApply(
    final BIMReplyInfo replyInfo,
    final BIMResultCallback<BIMFriendApplyInfo> callback)
java

回应好友申请。

传入参数

参数名	类型	说明
replyInfo	final BIMReplyInfo	回应信息, 参看 BIMReplyInfo。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback，BIMFriendApplyInfo。

markFriendApplyRead

public void com.bytedance.im.user.BIMContactExpandService.markFriendApplyRead(
    final BIMSimpleCallback callback)
java

标记好友申请已读。

传入参数

参数名	类型	说明
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback 。

addFriendListener

public void com.bytedance.im.user.BIMContactExpandService.addFriendListener(
    BIMFriendListener listener)
java

设置联系人监听。

传入参数

参数名	类型	说明
listener	BIMFriendListener	联系人消息事件回调监听方，参看 BIMFriendListener 。

getFriendApplyUnreadCount

public void com.bytedance.im.user.BIMContactExpandService.getFriendApplyUnreadCount(
    BIMResultCallback<Integer> callback)
java

获取好友申请未读数。

传入参数

参数名	类型	说明
callback	BIMResultCallback	结果回调，参看 BIMResultCallback 。

removeFriendListener

public boolean com.bytedance.im.user.BIMContactExpandService.removeFriendListener(
    BIMFriendListener listener)
java

移除联系人监听。

传入参数

参数名	类型	说明
listener	BIMFriendListener	结果回调，参看 BIMFriendListener 。

addToBlackList

public void com.bytedance.im.user.BIMContactExpandService.addToBlackList(
    BIMBlackListFriendInfo blackListFriendInfo,
    final BIMResultCallback<BIMUserFullInfo> callback)
java

添加该用户到黑名单。

传入参数

参数名	类型	说明
blackListFriendInfo	BIMBlackListFriendInfo	黑名单信息，参看 BIMBlackListFriendInfo。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback。

deleteFromBlackList

public void com.bytedance.im.user.BIMContactExpandService.deleteFromBlackList(
    long uid,
    final BIMSimpleCallback callback)
java

把该用户从黑名单中移除。

传入参数

参数名	类型	说明
uid	long	联系人用户 ID。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

checkUserInBlackList

public void com.bytedance.im.user.BIMContactExpandService.checkUserInBlackList(
    List<Long> ids,
    final BIMResultCallback<Map<Long,
    Boolean>> callback)
java

校验用户是否在黑名单中。

传入参数

参数名	类型	说明
ids	List	用户id列表。
callback	Boolean>>	结果回调，参看 BIMResultCallback。

getBlackList

public void com.bytedance.im.user.BIMContactExpandService.getBlackList(
    final BIMResultCallback<List<BIMUserFullInfo>> callback)
java

获取黑名单信息（全量）。

传入参数

参数名	类型	说明
callback	final BIMResultCallback<List>	结果回调，参看 BIMResultCallback, BIMUserFullInfo。

getBlackList

public void com.bytedance.im.user.BIMContactExpandService.getBlackList(
    long cursor,
    long limit,
    final BIMResultCallback<BIMUserInfoListResult> callback)
java

分页获取黑名单信息，按照拉黑时间从新到旧。

传入参数

参数名	类型	说明
cursor	long	游标，首页拉取可使用 0。
limit	long	查询条数。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMUserInfoListResult。

updateFriendAlias

public void com.bytedance.im.user.BIMContactExpandService.updateFriendAlias(
    long uid,
    String alias,
    final BIMSimpleCallback callback)
java

修改好友备注名。

传入参数

参数名	类型	说明
uid	long	好友用户 ID。
alias	String	好友备注名。
callback	final BIMSimpleCallback	结果回调，参看 BIMSimpleCallback。

getUserFullInfo

public void com.bytedance.im.user.BIMContactExpandService.getUserFullInfo(
    long uid,
    final BIMResultCallback<BIMUserFullInfo> callback)
java

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uid	long	用户 ID。
callback	final BIMResultCallback	全量信息，参看 BIMUserFullInfo。

getUserFullInfo

public void com.bytedance.im.user.BIMContactExpandService.getUserFullInfo(
    long uid,
    boolean syncServer,
    final BIMResultCallback<BIMUserFullInfo> callback)
java

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uid	long	用户 ID。
syncServer	boolean	是否强制同步服务端数据，如 false 则优先使用本地数据
callback	final BIMResultCallback	全量信息，参看 BIMUserFullInfo。

getUserFullInfoList

public void com.bytedance.im.user.BIMContactExpandService.getUserFullInfoList(
    List<Long> uidList,
    final BIMResultCallback<List<BIMUserFullInfo>> callback)
java

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uidList	List	用户 ID 列表。
callback	final BIMResultCallback<List>	全量信息，参看 BIMUserFullInfo。

getUserFullInfoList

public void com.bytedance.im.user.BIMContactExpandService.getUserFullInfoList(
    List<Long> uidList,
    boolean syncServer,
    final BIMResultCallback<List<BIMUserFullInfo>> callback)
java

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uidList	List	用户 ID 列表。
syncServer	boolean	是否强制同步服务端数据，如 false 则优先使用本地数据
callback	final BIMResultCallback<List>	全量信息，参看 BIMUserFullInfo。

setUserSelfPortrait

public void com.bytedance.im.user.BIMContactExpandService.setUserSelfPortrait(
    String portraitUrl,
    BIMResultCallback<BIMUserFullInfo> callback)
java

更新用户头像信息。

传入参数

参数名	类型	说明
portraitUrl	String	用户头像 url
callback	BIMResultCallback	用户信息，参看 BIMUserFullInfo。

setUserSelfNickName

public void com.bytedance.im.user.BIMContactExpandService.setUserSelfNickName(
    String nickName,
    BIMResultCallback<BIMUserFullInfo> callback)
java

更新用户昵称。

传入参数

参数名	类型	说明
nickName	String	用户昵称
callback	BIMResultCallback	用户信息，参看 BIMUserFullInfo。

setUserSelfExt

public void com.bytedance.im.user.BIMContactExpandService.setUserSelfExt(
    Map<String,
    String> ext,
    BIMResultCallback<BIMUserFullInfo> callback)
java

更新用户额外信息。

传入参数

参数名	类型	说明
ext	Map<String, String>	用户额外信息
callback	BIMResultCallback	用户信息，参看 BIMUserFullInfo。

updateUserSelfProfile

public void com.bytedance.im.user.BIMContactExpandService.updateUserSelfProfile(
    BIMUserProfile bimUserProfile,
    final BIMResultCallback<BIMUserFullInfo> callback)
java

更新用户信息详情。

传入参数

参数名	类型	说明
bimUserProfile	BIMUserProfile	用户信息详情，参看 BIMUserProfile。
callback	final BIMResultCallback	用户信息，参看 BIMUserFullInfo。

addFriendConversationListener

public void com.bytedance.im.user.BIMContactExpandService.addFriendConversationListener(
    BIMConversationListListener listener)
java

添加好友会话监听。

传入参数

参数名	类型	说明
listener	BIMConversationListListener	会话监听方，参看 BIMConversationListListener。

getFriendConversationList

public void com.bytedance.im.user.BIMContactExpandService.getFriendConversationList(
    final long cursor,
    final int count,
    final BIMResultCallback<BIMConversationListResult> callback)
java

获取好友会话列表。

传入参数

参数名	类型	说明
cursor	final long	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	final int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 100 个会话。
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMConversationListResult。

注意

历史朋友会话数量可能很多，因此建议采用分页查询的方式进行接口调用。
该接口拉取的是本地缓存的会话。若服务器会话有更新，SDK 内部会自动同步，并通过 BIMResultCallback 回调告知用户。
如果会话全部拉取完毕，结果回调 BIMResultCallback 中的 hasMore 获取字段值为 false。

getFriendConversationListTotalUnreadCount

public void com.bytedance.im.user.BIMContactExpandService.getFriendConversationListTotalUnreadCount(
    final BIMResultCallback<BIMUnReadInfo> callback)
java

获取所有好友会话的未读消息总数。

传入参数

参数名	类型	说明
callback	final BIMResultCallback	结果回调，参看 BIMResultCallback, BIMUnReadInfo。

注意
会话未读消息不包括设置为免打扰会话中的未读消息。

removeFriendConversationListener

public void com.bytedance.im.user.BIMContactExpandService.removeFriendConversationListener(
    BIMConversationListListener listener)
java

移除好友会话监听。

传入参数

参数名	类型	说明
listener	BIMConversationListListener	会话监听方，参看 BIMConversationListListener。

BIMSearchExpandService

public class com.bytedance.im.search.api.BIMSearchExpandService
java

IM SDK 消息内容搜索入口。
获取实例方式 BIMClient.getInstance().getService(BIMSearchExpandService.class)，参看 BIMClient。

成员函数

返回	名称
void	searchLocalMessage

函数说明

searchLocalMessage

public void com.bytedance.im.search.api.BIMSearchExpandService.searchLocalMessage(
    final String key,
    final String conversationId,
    final BIMResultCallback<List<BIMSearchMsgInfo>> callback)
java

搜索本地消息。

传入参数

参数名	类型	说明
conversationId	final String	会话 ID。
callback	final BIMResultCallback<List>	结果回调，参看 BIMResultCallback, BIMMessage。