BIMClient

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

IMSDK 对外接口类, 通过此类提供所有 IMSDK 能力接口。

静态函数

返回	名称
static BIMClient	getInstance

成员函数

返回	名称
boolean	initSDK
void	unInitSDK
void	login
void	logout
void	addConnectListener
void	removeConnectListener
long	getCurrentUserID
String	getToken
String	getVersion
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	markConversationRead
void	stickTopConversation
void	muteConversation
void	setConversationDraft
void	getHistoryMessageList
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

函数说明

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(
    long uid,
    String token,
    BIMSimpleCallback callback)
java

登录服务器。

传入参数

参数名	类型	说明
uid	long	用户 ID。
token	String	用户 Token。
callback	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 版本号。

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(
    String conversationId,
    BIMSimpleCallback callback)
java

删除会话。

传入参数

参数名	类型	说明
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。

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。