BIMConnectListener

public interface com.bytedance.im.core.api.interfaces.BIMConnectListener
java

长链状态监听方。

成员函数

返回	名称
void	onConnectStatusChanged
void	onTokenInvalid

函数说明

onConnectStatusChanged

void com.bytedance.im.core.api.interfaces.BIMConnectListener.onConnectStatusChanged(
    BIMConnectStatus status)
java

长链状态改变回调。

传入参数

参数名	类型	说明
status	BIMConnectStatus	长链状态码, 参看 BIMConnectStatus。

onTokenInvalid

void com.bytedance.im.core.api.interfaces.BIMConnectListener.onTokenInvalid(
    BIMErrorCode code)
java

Token 失效回调。

传入参数

参数名	类型	说明
code	BIMErrorCode	Token 过期错误码, 参看 BIMErrorCode。

BIMConversationListListener

public interface com.bytedance.im.core.api.interfaces.BIMConversationListListener
java

会话监听方。

成员函数

返回	名称
void	onNewConversation
void	onConversationChanged
void	onConversationDelete
void	onTotalUnreadMessageCountChanged

函数说明

onNewConversation

void com.bytedance.im.core.api.interfaces.BIMConversationListListener.onNewConversation(
    List<BIMConversation> conversationList)
java

获取到新的会话。

传入参数

参数名	类型	说明
conversationList	List	会话列表，参看 BIMConversation。

onConversationChanged

void com.bytedance.im.core.api.interfaces.BIMConversationListListener.onConversationChanged(
    List<BIMConversation> conversationList)
java

会话发生更新。

传入参数

参数名	类型	说明
conversationList	List	会话列表，参看 BIMConversation。

onConversationDelete

void com.bytedance.im.core.api.interfaces.BIMConversationListListener.onConversationDelete(
    List<BIMConversation> conversationList)
java

会话被删除。

传入参数

参数名	类型	说明
conversationList	List	会话列表，参看 BIMConversation。

onTotalUnreadMessageCountChanged

void com.bytedance.im.core.api.interfaces.BIMConversationListListener.onTotalUnreadMessageCountChanged(
    int totalUnreadCount)
java

会话未读消息数发生变化。

传入参数

参数名	类型	说明
totalUnreadCount	int	会话未读消息数。

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

BIMLogListener

public interface com.bytedance.im.core.api.interfaces.BIMLogListener
java

日志监听方。

成员函数

返回	名称
void	onLog

函数说明

onLog

void com.bytedance.im.core.api.interfaces.BIMLogListener.onLog(
    BIMLogLevel logLevel,
    String content)
java

主线程日志回调。

传入参数

参数名	类型	说明
logLevel	BIMLogLevel	日志级别。
content	String	日志内容。

BIMMessageListener

public interface com.bytedance.im.core.api.interfaces.BIMMessageListener
java

消息监听方。

成员函数

返回	名称
void	onReceiveMessage
void	onSendMessage
void	onDeleteMessage
void	onRecallMessage
void	onUpdateMessage

函数说明

onReceiveMessage

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onReceiveMessage(
    BIMMessage message)
java

收到新消息。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onSendMessage

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onSendMessage(
    BIMMessage message)
java

发送消息入库完成。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onDeleteMessage

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onDeleteMessage(
    BIMMessage message)
java

收到的消息被删除。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onRecallMessage

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onRecallMessage(
    BIMMessage message)
java

收到的消息被撤回。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onUpdateMessage

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onUpdateMessage(
    BIMMessage message)
java

收到的消息被修改。（内容+扩展）

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

BIMResultCallback

public abstract class com.bytedance.im.core.api.interfaces.BIMResultCallback
java

结果回调。

成员函数

返回	名称
abstract void	onSuccess
abstract void	onFailed

函数说明

onSuccess

public abstract void com.bytedance.im.core.api.interfaces.BIMResultCallback.onSuccess(
    T t)
java

成功回调。

传入参数

参数名	类型	说明
t	T	回调数据

onFailed

public abstract void com.bytedance.im.core.api.interfaces.BIMResultCallback.onFailed(
    BIMErrorCode code)
java

失败回调。

传入参数

参数名	类型	说明
code	BIMErrorCode	错误码，参看 BIMErrorCode。

BIMSendCallback

public abstract class com.bytedance.im.core.api.interfaces.BIMSendCallback
java

发送结果回调。

成员函数

返回	名称
void	onProgress
void	onSaved
abstract void	onSuccess
abstract void	onError

函数说明

onProgress

public void com.bytedance.im.core.api.interfaces.BIMSendCallback.onProgress(
    BIMMessage message,
    int progress)
java

媒体消息上传进度。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。
progress	int	上传进度。

onSaved

public void com.bytedance.im.core.api.interfaces.BIMSendCallback.onSaved(
    BIMMessage bimMessage)
java

消息已保存。

传入参数

参数名	类型	说明
bimMessage	BIMMessage	消息体，参看 BIMMessage。

onSuccess

public abstract void com.bytedance.im.core.api.interfaces.BIMSendCallback.onSuccess(
    BIMMessage bimMessage)
java

消息发送成功。

传入参数

参数名	类型	说明
bimMessage	BIMMessage	消息体，参看 BIMMessage。

onError

public abstract void com.bytedance.im.core.api.interfaces.BIMSendCallback.onError(
    BIMMessage bimMessage,
    BIMErrorCode code)
java

消息发送失败。

传入参数

参数名	类型	说明
bimMessage	BIMMessage	消息体，参看 BIMMessage。
code	BIMErrorCode	错误码，参看 BIMErrorCode。

BIMSimpleCallback

public abstract class com.bytedance.im.core.api.interfaces.BIMSimpleCallback
java

完成回调。

成员函数

返回	名称
abstract void	onSuccess
abstract void	onFailed

函数说明

onSuccess

public abstract void com.bytedance.im.core.api.interfaces.BIMSimpleCallback.onSuccess()
java

成功。

onFailed

public abstract void com.bytedance.im.core.api.interfaces.BIMSimpleCallback.onFailed(
    BIMErrorCode code)
java

失败。

传入参数

参数名	类型	说明
code	BIMErrorCode	错误码，参看 BIMErrorCode。

BIMSyncServerListener

public interface com.bytedance.im.core.api.interfaces.BIMSyncServerListener
java

同步服务端会话、消息数据监听。

成员函数

返回	名称
void	onSyncServerStart
void	onSyncServerFinish
void	onSyncServerFailed

函数说明

onSyncServerStart

void com.bytedance.im.core.api.interfaces.BIMSyncServerListener.onSyncServerStart()
java

开始同步服务端会话、消息数据。

onSyncServerFinish

void com.bytedance.im.core.api.interfaces.BIMSyncServerListener.onSyncServerFinish()
java

同步服务端会话、消息数据成功。

onSyncServerFailed

void com.bytedance.im.core.api.interfaces.BIMSyncServerListener.onSyncServerFailed()
java

同步服务端会话、消息数据失败。

BIMLiveConversationListener

public interface com.bytedance.im.live.api.BIMLiveConversationListener
java

直播群成员事件回调监听方。

成员函数

返回	名称
void	onConversationChanged

函数说明

onConversationChanged

void com.bytedance.im.live.api.BIMLiveConversationListener.onConversationChanged(
    BIMConversation conversation)
java

直播群信息发生变化。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。

BIMLiveGroupMemberEventListener

public abstract class com.bytedance.im.live.api.BIMLiveGroupMemberEventListener
java

直播群成员事件回调监听方。

成员函数

返回	名称
abstract void	onMemberKicked
abstract void	onMemberOwnerChanged
abstract void	onMemberSilent
abstract void	onAllMemberSilent
abstract void	onAddAdmin
abstract void	onRemoveAdmin

函数说明

onMemberKicked

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberKicked(
    BIMConversation conversation,
    List<BIMMember> memberList,
    long operatorID)
java

成员被踢出直播群。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
memberList	List	成员列表,参看 BIMMember。
operatorID	long	操作用户 ID

onMemberOwnerChanged

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberOwnerChanged(
    BIMConversation conversation,
    long fromUID,
    long toUID)
java

群主发生变化。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
fromUID	long	旧群主 UID。
toUID	long	新群主 UID。

onMemberSilent

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberSilent(
    BIMConversation conversation,
    List<BIMMember> memberSilentList,
    BIMBlockStatus status,
    long operatorId)
java

群成员被禁言。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
memberSilentList	List	禁言、取消成员列表
status	BIMBlockStatus	禁言状态，参看 BIMBlockStatus。
operatorId	long	操作用户 ID

onAllMemberSilent

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onAllMemberSilent(
    BIMConversation conversation,
    BIMBlockStatus status,
    long operatorId)
java

禁言、取消会话(禁言、取消所有人)。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
status	BIMBlockStatus	禁言状态，参看 BIMBlockStatus。
operatorId	long	操作用户 ID。

onAddAdmin

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onAddAdmin(
    BIMConversation conversation,
    List<BIMMember> adminList,
    long operatorId)
java

添加管理员。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
adminList	List	添加的管理员列表，参看 BIMMember。
operatorId	long	操作用户 ID。

onRemoveAdmin

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onRemoveAdmin(
    BIMConversation conversation,
    List<BIMMember> uidList,
    long operatorId)
java

添加管理员移除管理员。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
uidList	List	移出的管理员列表，参看 BIMMember。
operatorId	long	操作用户 ID。

BIMLiveMessageListener

public interface com.bytedance.im.live.api.BIMLiveMessageListener
java

消息监听方。

成员函数

返回	名称
void	onReceiveMessage
void	onSendMessage
void	onDeleteMessage
void	onUpdateMessage

函数说明

onReceiveMessage

void com.bytedance.im.live.api.BIMLiveMessageListener.onReceiveMessage(
    BIMMessage message)
java

收到新消息。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onSendMessage

void com.bytedance.im.live.api.BIMLiveMessageListener.onSendMessage(
    BIMMessage message)
java

发送消息入库完成。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onDeleteMessage

void com.bytedance.im.live.api.BIMLiveMessageListener.onDeleteMessage(
    BIMMessage message)
java

收到的消息被删除。

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

onUpdateMessage

void com.bytedance.im.live.api.BIMLiveMessageListener.onUpdateMessage(
    BIMMessage message)
java

收到的消息被修改。（内容+扩展）

传入参数

参数名	类型	说明
message	BIMMessage	消息体，参看 BIMMessage。

BIMFriendListener

public abstract class com.bytedance.im.user.api.BIMFriendListener
java

好友事件回调监听方。

成员函数

返回	名称
abstract void	onFriendApply
abstract void	onFriendDelete
abstract void	onFriendAdd
abstract void	onFriendAgree
abstract void	onFriendRefuse
abstract void	onFriendApplyUnreadCountChanged
abstract void	onBlackListAdd
abstract void	onBlackListDelete
abstract void	onBlackListUpdate

函数说明

onFriendApply

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendApply(
    BIMFriendApplyInfo applyInfo)
java

申请成为好友回调。

传入参数

参数名	类型	说明
applyInfo	BIMFriendApplyInfo	申请信息，参看 BIMFriendApplyInfo。

onFriendDelete

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendDelete(
    BIMFriendInfo friendInfo)
java

删除好友回调。

传入参数

参数名	类型	说明
friendInfo	BIMFriendInfo	好友信息，参看 BIMFriendInfo。

onFriendAdd

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendAdd(
    BIMFriendInfo friendInfo)
java

好友新增（同意好友）。

传入参数

参数名	类型	说明
friendInfo	BIMFriendInfo	好友信息，参看 BIMFriendInfo。

onFriendAgree

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendAgree(
    BIMFriendApplyInfo applyInfo)
java

通过好友申请。

传入参数

参数名	类型	说明
applyInfo	BIMFriendApplyInfo	好友申请信息，参看 BIMFriendApplyInfo。

onFriendRefuse

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendRefuse(
    BIMFriendApplyInfo applyInfo)
java

拒绝好友申请。

传入参数

参数名	类型	说明
applyInfo	BIMFriendApplyInfo	好友申请信息，参看 BIMFriendApplyInfo。

onFriendApplyUnreadCountChanged

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendApplyUnreadCountChanged(
    int count)
java

好友申请未读数变化

传入参数

参数名	类型	说明
count	int	变化后的未读数。

onBlackListAdd

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListAdd(
    BIMBlackListFriendInfo blackListFriendInfo)
java

新添加黑名单回调。

传入参数

参数名	类型	说明
blackListFriendInfo	BIMBlackListFriendInfo	好友信息，参看 BIMBlackListFriendInfo。

onBlackListDelete

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListDelete(
    BIMBlackListFriendInfo blackListFriendInfo)
java

删除黑名单回调。

传入参数

参数名	类型	说明
blackListFriendInfo	BIMBlackListFriendInfo	好友信息，参看 BIMBlackListFriendInfo。

onBlackListUpdate

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListUpdate(
    BIMBlackListFriendInfo blackListFriendInfo)
java

修改黑名单回调。

传入参数

参数名	类型	说明
blackListFriendInfo	BIMBlackListFriendInfo	好友信息，参看 BIMBlackListFriendInfo。