agora_chat_SDK 1.0.6
agora java chat SDK
Public 成员函数 | 所有成员列表
io.agora.ChatRoomChangeListener接口 参考

Public 成员函数

void onChatRoomDestroyed (final String roomId, final String roomName)
 
void onMemberJoined (final String roomId, final String participant)
 
void onMemberExited (final String roomId, final String roomName, final String participant)
 
void onRemovedFromChatRoom (final int reason, final String roomId, final String roomName, final String participant)
 
void onMuteListAdded (final String chatRoomId, final List< String > mutes, final long expireTime)
 
void onMuteListRemoved (final String chatRoomId, final List< String > mutes)
 
void onWhiteListAdded (final String chatRoomId, final List< String > whitelist)
 
void onWhiteListRemoved (final String chatRoomId, final List< String > whitelist)
 
void onAllMemberMuteStateChanged (final String chatRoomId, final boolean isMuted)
 
void onAdminAdded (final String chatRoomId, final String admin)
 
void onAdminRemoved (final String chatRoomId, final String admin)
 
void onOwnerChanged (final String chatRoomId, final String newOwner, final String oldOwner)
 
void onAnnouncementChanged (String chatRoomId, String announcement)
 
default void onSpecificationChanged (ChatRoom chatRoom)
 

详细描述

聊天室事件监听接口。

通过 io.agora.chat.ChatRoomManager 进行注册和解注册,具体如下:

注册聊天室事件监听:
```java
ChatRoomManager manager = ChatClient.getInstance().chatroomManager();
manager.addChatRoomChangeListener(mChatRoomChangeListener);
```

解注册聊天室事件监听:
```java
ChatRoomManager manager = ChatClient.getInstance().chatroomManager();
manager.removeChatRoomListener(mChatRoomChangeListener);
```

成员函数说明

◆ onAdminAdded()

void io.agora.ChatRoomChangeListener.onAdminAdded ( final String  chatRoomId,
final String  admin 
)

有成员提升为管理员权限。

参数
chatRoomId聊天室 ID。
admin被提升管理员的成员。

◆ onAdminRemoved()

void io.agora.ChatRoomChangeListener.onAdminRemoved ( final String  chatRoomId,
final String  admin 
)

移除管理员权限。

参数
chatRoomId聊天室 ID。
admin被移除的管理员。

◆ onAllMemberMuteStateChanged()

void io.agora.ChatRoomChangeListener.onAllMemberMuteStateChanged ( final String  chatRoomId,
final boolean  isMuted 
)

全员禁言状态的改变。

参数
chatRoomId聊天室 ID。
isMuted是否开启了全员禁言。

◆ onAnnouncementChanged()

void io.agora.ChatRoomChangeListener.onAnnouncementChanged ( String  chatRoomId,
String  announcement 
)

聊天室公告更改事件。

参数
chatRoomId聊天室 ID。
announcement更新的公告内容。

◆ onChatRoomDestroyed()

void io.agora.ChatRoomChangeListener.onChatRoomDestroyed ( final String  roomId,
final String  roomName 
)

聊天室被解散。

参数
roomId聊天室 ID。
roomName聊天室名称。

◆ onMemberExited()

void io.agora.ChatRoomChangeListener.onMemberExited ( final String  roomId,
final String  roomName,
final String  participant 
)

聊天室成员主动退出事件。

参数
roomId聊天室 ID。
roomName聊天室名字。
participant退出的成员 ID。

◆ onMemberJoined()

void io.agora.ChatRoomChangeListener.onMemberJoined ( final String  roomId,
final String  participant 
)

聊天室加入新成员事件。

参数
roomId聊天室 ID。
participant新成员 username。

◆ onMuteListAdded()

void io.agora.ChatRoomChangeListener.onMuteListAdded ( final String  chatRoomId,
final List< String >  mutes,
final long  expireTime 
)

有成员被禁言。 禁言期间成员不能发送发消息。

参数
chatRoomId聊天室 ID。
mutes禁言的成员。
expireTime禁言有效期,单位是毫秒。

◆ onMuteListRemoved()

void io.agora.ChatRoomChangeListener.onMuteListRemoved ( final String  chatRoomId,
final List< String >  mutes 
)

有成员从禁言列表中移除。

参数
chatRoomId聊天室 ID。
mutes从禁言列表中移除的成员名单。

◆ onOwnerChanged()

void io.agora.ChatRoomChangeListener.onOwnerChanged ( final String  chatRoomId,
final String  newOwner,
final String  oldOwner 
)

转移聊天室拥有者。

参数
chatRoomId聊天室 ID。
newOwner新所有者。
oldOwner原聊天室所有者。

◆ onRemovedFromChatRoom()

void io.agora.ChatRoomChangeListener.onRemovedFromChatRoom ( final int  reason,
final String  roomId,
final String  roomName,
final String  participant 
)

聊天室人员被移除。

参数
reason用户被移出聊天室的原因:
  • xxx BE_KICKED:该用户被聊天室管理员移除;
  • xxxBE_LICKED)FOR_OFFLINE:该用户由于当前设备断网被服务器移出聊天室。
roomId聊天室 ID。
roomName聊天室名字。
participant被移除人员 ID。

◆ onSpecificationChanged()

default void io.agora.ChatRoomChangeListener.onSpecificationChanged ( ChatRoom  chatRoom)

聊天室信息更新回调。

参数
chatRoom聊天室。

◆ onWhiteListAdded()

void io.agora.ChatRoomChangeListener.onWhiteListAdded ( final String  chatRoomId,
final List< String >  whitelist 
)

白名单成员增加。

参数
chatRoomId聊天室 ID。
whitelist白名单中增加的成员名单。

◆ onWhiteListRemoved()

void io.agora.ChatRoomChangeListener.onWhiteListRemoved ( final String  chatRoomId,
final List< String >  whitelist 
)

白名单成员减少。

参数
chatRoomId聊天室 ID。
whitelist白名单中移除的成员名单。

该接口的文档由以下文件生成: