agora_chat_SDK 1.0.6
agora java chat SDK
Public Member Functions | List of all members
io.agora.ChatRoomChangeListener Interface Reference

Public Member Functions

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)
 

Detailed Description

The chat room change listener.

Register/unregister it by io.agora.chat.ChatRoomManager:

Register chat room change listener:
```java
ChatRoomManager manager = ChatClient.getInstance().chatroomManager();
manager.addChatRoomChangeListener(mChatRoomChangeListener);
```

Unregister chat room change listener:
```java
ChatRoomManager manager = ChatClient.getInstance().chatroomManager();
manager.removeChatRoomListener(mChatRoomChangeListener);
```

Member Function Documentation

◆ onAdminAdded()

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

Occurs when a member has been changed to an admin.

Parameters
chatRoomIdThe chatroom ID.
adminThe member who has been changed to an admin.

◆ onAdminRemoved()

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

Occurs when ␈an admin is been removed.

Parameters
chatRoomIdThe chatroom ID.
adminThe member whose admin permission is removed.

◆ onAllMemberMuteStateChanged()

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

Occurs when all members in the chat room are muted or unmuted.

Parameters
chatRoomIdThe chatroom ID.
isMutedWhether all chat room members is muted or unmuted.

◆ onAnnouncementChanged()

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

Occurs when the announcement changed.

Parameters
chatRoomIdThe chatroom ID.
announcementThe changed announcement.

◆ onChatRoomDestroyed()

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

Occurs when the chat room is destroyed.

Parameters
roomIdThe chatroom ID.
roomNameThe chatroom subject.

◆ onMemberExited()

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

Occurs when a member leaves the chatroom.

Parameters
roomIdThe chatroom ID.
roomNameThe name of the chatroom.
participantThe member who leaves the chatroom.

◆ onMemberJoined()

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

Occurs when a member join the chatroom.

Parameters
roomIdThe chatroom ID.
participantThe new member's username.

◆ onMuteListAdded()

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

Occurs when there are chat room member(s) muted (added to mute list), The muted members are not allowed to post message temporarily based on muted time duration.

Parameters
chatRoomIdThe chatroom ID.
mutesThe members to be muted.
expireTimeThe mute duration.

◆ onMuteListRemoved()

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

Occurs when there are chat room member(s) unmuted (removed from mute list).

Parameters
chatRoomIdThe chatroom ID.
mutesThe member(s) muted is removed from the mute list.

◆ onOwnerChanged()

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

Occurs when the chat room ownership has been transferred.

Parameters
chatRoomIdThe chatroom ID.
newOwnerThe new owner.
oldOwnerThe previous owner.

◆ onRemovedFromChatRoom()

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

Occurs when a member is dismissed from a chat room.

Parameters
reasonThe reason why the user is removed from the chatroom:
  • xxxBE_KICKED: The user is removed by the chatroom owner.
  • xxxBE_KICKED_FOR_OFFINE: The user is disconnected from the server, probably due to network interruption.
roomIdThe chatroom ID.
roomNameThe name of the chatroom.
participantThe member is dismissed from a chat room.

◆ onSpecificationChanged()

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

Occurs when the chatroom specification changed.

Parameters
chatRoomThe chatroom.

◆ onWhiteListAdded()

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

Occurs when the chat room member(s) is added to the allowlist.

Parameters
chatRoomIdThe chatroom ID.
whitelistThe member(s) to be added to the allowlist.

◆ onWhiteListRemoved()

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

Occurs when the chat room member(s) is removed from the allowlist.

Parameters
chatRoomIdThe chatroom ID.
whitelistThe member(s) is removed from the allowlist.

The documentation for this interface was generated from the following file: