文档中心

回调

最近更新时间：2024.03.11 19:19:40

首次发布时间：2023.04.24 11:11:45

BIMConnectListener

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

长链状态监听方。

成员函数

返回	名称
void	onConnectStatusChanged
void	onTokenInvalid

函数说明

onConnectStatusChanged

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

长链状态改变回调。

传入参数

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

onTokenInvalid

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

Token 失效回调。

传入参数

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

BIMConversationListListener

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

会话监听方。

成员函数

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

函数说明

onNewConversation

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

获取到新的会话。

传入参数

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

onConversationChanged

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

会话发生更新。

传入参数

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

onConversationDelete

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

会话被删除。

传入参数

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

onTotalUnreadMessageCountChanged

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

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

传入参数

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

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

onConversationRead

void com.bytedance.im.core.api.interfaces.BIMConversationListListener.onConversationRead(
    String conversationId,
    long fromUid)

收到会话已读回执。

传入参数

参数名	类型	说明
conversationId	String	会话ID。
fromUid	long	发送会话已读回执的用户ID。

BIMLogListener

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

日志监听方。

成员函数

返回	名称
void	onLog

函数说明

onLog

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

主线程日志回调。

传入参数

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

BIMMessageListener

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

消息监听方。

成员函数

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

函数说明

onReceiveMessage

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

收到新消息。

传入参数

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

onSendMessage

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

发送消息入库完成。

传入参数

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

onDeleteMessage

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

收到的消息被删除。

传入参数

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

onRecallMessage

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

收到的消息被撤回。

传入参数

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

onUpdateMessage

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

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

传入参数

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

onReceiveMessagesReadReceipt

void com.bytedance.im.core.api.interfaces.BIMMessageListener.onReceiveMessagesReadReceipt(
    List<BIMMessageReadReceipt> receiptList)

收到消息已读回执。

传入参数

参数名	类型	说明
receiptList	List	消息体，参看 BIMMessageReadReceipt。

BIMResultCallback

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

结果回调。

成员函数

返回	名称
abstract void	onSuccess
abstract void	onFailed

函数说明

onSuccess

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

成功回调。

传入参数

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

onFailed

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

失败回调。

传入参数

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

BIMSendCallback

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

发送结果回调。

成员函数

返回	名称
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)

媒体消息上传进度。

传入参数

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

onSaved

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

消息已保存。

传入参数

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

onSuccess

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

消息发送成功。

传入参数

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

onError

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

消息发送失败。

传入参数

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

BIMSimpleCallback

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

完成回调。

成员函数

返回	名称
abstract void	onSuccess
abstract void	onFailed

函数说明

onSuccess

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

成功。

onFailed

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

失败。

传入参数

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

BIMSyncServerListener

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

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

成员函数

返回	名称
void	onSyncServerStart
void	onSyncServerFinish
void	onSyncServerFailed

函数说明

onSyncServerStart

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

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

onSyncServerFinish

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

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

onSyncServerFailed

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

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

BIMLiveConversationListener

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

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

成员函数

返回	名称
void	onConversationChanged

函数说明

onConversationChanged

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

直播群信息发生变化。

传入参数

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

BIMLiveGroupMarkTypeListener

public interface com.bytedance.im.live.api.BIMLiveGroupMarkTypeListener

直播群标记类型回调监听方。

成员函数

返回	名称
void	onMarkTypesAdd
void	onMarkTypesDeleted

函数说明

onMarkTypesAdd

void com.bytedance.im.live.api.BIMLiveGroupMarkTypeListener.onMarkTypesAdd(
    BIMConversation conversation,
    BIMLiveGroupMarkTypeChangeInfo changeInfo)

直播群新增标记类型。

传入参数

参数名	类型	说明
changeInfo	BIMLiveGroupMarkTypeChangeInfo	标记更新信息，参看 BIMLiveGroupMarkTypeChangeInfo。
conversation	BIMConversation	会话信息，参看 BIMConversation。

onMarkTypesDeleted

void com.bytedance.im.live.api.BIMLiveGroupMarkTypeListener.onMarkTypesDeleted(
    BIMConversation conversation,
    BIMLiveGroupMarkTypeChangeInfo changeInfo)

直播群删除标记类型。

传入参数

参数名	类型	说明
changeInfo	BIMLiveGroupMarkTypeChangeInfo	标记更新信息，参看 BIMLiveGroupMarkTypeChangeInfo。

BIMLiveGroupMemberEventListener

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

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

成员函数

返回	名称
void	onMemberJoined
void	onMemberLeave
abstract void	onMemberKicked
abstract void	onMemberOwnerChanged
abstract void	onMemberSilent
abstract void	onAllMemberSilent
abstract void	onAddAdmin
abstract void	onRemoveAdmin
abstract void	onMemberInfoChanged
void	onBatchMemberInfoChanged

函数说明

onMemberJoined

public void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberJoined(
    BIMConversation conversation,
    List<BIMMember> memberList)

成员加入群聊。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
memberList	List	成员列表,参看 BIMMember。

onMemberLeave

public void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberLeave(
    BIMConversation conversation,
    List<BIMMember> memberList)

成员退出群聊。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息, 参看 BIMConversation。
memberList	List	成员列表,参看 BIMMember。

onMemberKicked

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

成员被踢出直播群。

传入参数

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

群主发生变化。

传入参数

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

群成员被禁言。

传入参数

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

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

传入参数

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

添加管理员。

传入参数

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

添加管理员移除管理员。

传入参数

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

onMemberInfoChanged

public abstract void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onMemberInfoChanged(
    BIMConversation conversation,
    BIMMember member)

成员信息变更。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息，参看 BIMConversation。
member	BIMMember	变更的群成员信息，参看 BIMMember。

onBatchMemberInfoChanged

public void com.bytedance.im.live.api.BIMLiveGroupMemberEventListener.onBatchMemberInfoChanged(
    BIMConversation conversation,
    List<BIMMember> members)

批量成员信息变更。

传入参数

参数名	类型	说明
conversation	BIMConversation	会话信息，参看 BIMConversation。
members	List	批量变更的群成员信息，参看 BIMMember。

BIMLiveMessageListener

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

消息监听方。

成员函数

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

函数说明

onReceiveMessage

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

收到新消息。

传入参数

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

onSendMessage

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

发送消息入库完成。

传入参数

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

onDeleteMessage

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

收到的消息被删除。

传入参数

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

onUpdateMessage

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

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

传入参数

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

BIMFriendListener

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

好友事件回调监听方。

成员函数

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

函数说明

onFriendApply

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

申请成为好友回调。

传入参数

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

onFriendDelete

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendDelete(
    BIMUserFullInfo userFullInfo)

删除好友回调。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onFriendUpdate

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendUpdate(
    BIMUserFullInfo userFullInfo)

好友信息变更回调。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onFriendAdd

public abstract void com.bytedance.im.user.api.BIMFriendListener.onFriendAdd(
    BIMUserFullInfo userFullInfo)

好友新增（同意好友）。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onFriendAgree

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

通过好友申请。

传入参数

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

onFriendRefuse

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

拒绝好友申请。

传入参数

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

onFriendApplyUnreadCountChanged

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

好友申请未读数变化

传入参数

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

onBlackListAdd

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListAdd(
    BIMUserFullInfo userFullInfo)

新添加黑名单回调。

传入参数

参数名	类型	说明
userFullInf	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onBlackListDelete

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListDelete(
    BIMUserFullInfo userFullInfo)

删除黑名单回调。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onBlackListUpdate

public abstract void com.bytedance.im.user.api.BIMFriendListener.onBlackListUpdate(
    BIMUserFullInfo userFullInfo)

修改黑名单回调。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	好友信息，参看 BIMUserFullInfo。

onUserProfileUpdate

public abstract void com.bytedance.im.user.api.BIMFriendListener.onUserProfileUpdate(
    BIMUserFullInfo userFullInfo)

用户信息更新回调。

传入参数

参数名	类型	说明
userFullInfo	BIMUserFullInfo	用户信息，参看 BIMUserFullInfo。

BIMConnectListener

成员函数

函数说明

onConnectStatusChanged

onTokenInvalid

BIMConversationListListener

成员函数

函数说明

onNewConversation

onConversationChanged

onConversationDelete

onTotalUnreadMessageCountChanged

onConversationRead

BIMLogListener

成员函数

函数说明

onLog

BIMMessageListener

成员函数

函数说明

onReceiveMessage

onSendMessage

onDeleteMessage

onRecallMessage

onUpdateMessage

onReceiveMessagesReadReceipt

BIMResultCallback

成员函数

函数说明

onSuccess

onFailed

BIMSendCallback

成员函数

函数说明

onProgress

onSaved

onSuccess

onError

BIMSimpleCallback

成员函数

函数说明

onSuccess

onFailed

BIMSyncServerListener

成员函数

函数说明

onSyncServerStart

onSyncServerFinish

onSyncServerFailed

BIMLiveConversationListener

成员函数

函数说明

onConversationChanged

BIMLiveGroupMarkTypeListener

成员函数

函数说明

onMarkTypesAdd

onMarkTypesDeleted

BIMLiveGroupMemberEventListener

成员函数

函数说明

onMemberJoined

onMemberLeave

onMemberKicked

onMemberOwnerChanged

onMemberSilent

onAllMemberSilent

onAddAdmin

onRemoveAdmin

onMemberInfoChanged

onBatchMemberInfoChanged

BIMLiveMessageListener

成员函数

函数说明

onReceiveMessage

onSendMessage

onDeleteMessage

onUpdateMessage

BIMFriendListener

成员函数

函数说明

onFriendApply

onFriendDelete

onFriendUpdate

onFriendAdd

onFriendAgree

onFriendRefuse

onFriendApplyUnreadCountChanged

onBlackListAdd

onBlackListDelete

onBlackListUpdate

onUserProfileUpdate

实时音视频

回调

成员函数

函数说明

onConnectStatusChanged

onTokenInvalid

成员函数

函数说明

onNewConversation

onConversationChanged

onConversationDelete

onTotalUnreadMessageCountChanged

onConversationRead

成员函数

函数说明

onLog

成员函数

函数说明

onReceiveMessage

onSendMessage

onDeleteMessage

onRecallMessage

onUpdateMessage

onReceiveMessagesReadReceipt

成员函数

函数说明

onSuccess

onFailed

成员函数

函数说明

onProgress

onSaved

onSuccess

onError

成员函数

函数说明

onSuccess

onFailed

成员函数

函数说明

onSyncServerStart

onSyncServerFinish

onSyncServerFailed

成员函数

函数说明

onConversationChanged

成员函数

函数说明

onMarkTypesAdd

onMarkTypesDeleted

成员函数

函数说明

onMemberJoined

onMemberLeave

onMemberKicked

onMemberOwnerChanged

onMemberSilent

onAllMemberSilent

onAddAdmin

onRemoveAdmin

onMemberInfoChanged

onBatchMemberInfoChanged

成员函数

函数说明

onReceiveMessage

onSendMessage

onDeleteMessage

onUpdateMessage

成员函数

函数说明

onFriendApply

onFriendDelete

onFriendUpdate

onFriendAdd

onFriendAgree

onFriendRefuse

onFriendApplyUnreadCountChanged

onBlackListAdd

onBlackListDelete

onBlackListUpdate