agora_chat_SDK 1.0.6
agora java chat SDK
|
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) |
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); ```
void io.agora.ChatRoomChangeListener.onAdminAdded | ( | final String | chatRoomId, |
final String | admin | ||
) |
Occurs when a member has been changed to an admin.
chatRoomId | The chatroom ID. |
admin | The member who has been changed to an admin. |
void io.agora.ChatRoomChangeListener.onAdminRemoved | ( | final String | chatRoomId, |
final String | admin | ||
) |
Occurs when ␈an admin is been removed.
chatRoomId | The chatroom ID. |
admin | The member whose admin permission is removed. |
void io.agora.ChatRoomChangeListener.onAllMemberMuteStateChanged | ( | final String | chatRoomId, |
final boolean | isMuted | ||
) |
Occurs when all members in the chat room are muted or unmuted.
chatRoomId | The chatroom ID. |
isMuted | Whether all chat room members is muted or unmuted. |
void io.agora.ChatRoomChangeListener.onAnnouncementChanged | ( | String | chatRoomId, |
String | announcement | ||
) |
Occurs when the announcement changed.
chatRoomId | The chatroom ID. |
announcement | The changed announcement. |
void io.agora.ChatRoomChangeListener.onChatRoomDestroyed | ( | final String | roomId, |
final String | roomName | ||
) |
Occurs when the chat room is destroyed.
roomId | The chatroom ID. |
roomName | The chatroom subject. |
void io.agora.ChatRoomChangeListener.onMemberExited | ( | final String | roomId, |
final String | roomName, | ||
final String | participant | ||
) |
Occurs when a member leaves the chatroom.
roomId | The chatroom ID. |
roomName | The name of the chatroom. |
participant | The member who leaves the chatroom. |
void io.agora.ChatRoomChangeListener.onMemberJoined | ( | final String | roomId, |
final String | participant | ||
) |
Occurs when a member join the chatroom.
roomId | The chatroom ID. |
participant | The new member's username. |
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.
chatRoomId | The chatroom ID. |
mutes | The members to be muted. |
expireTime | The mute duration. |
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).
chatRoomId | The chatroom ID. |
mutes | The member(s) muted is removed from the mute list. |
void io.agora.ChatRoomChangeListener.onOwnerChanged | ( | final String | chatRoomId, |
final String | newOwner, | ||
final String | oldOwner | ||
) |
Occurs when the chat room ownership has been transferred.
chatRoomId | The chatroom ID. |
newOwner | The new owner. |
oldOwner | The previous owner. |
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.
reason | The reason why the user is removed from the chatroom:
|
roomId | The chatroom ID. |
roomName | The name of the chatroom. |
participant | The member is dismissed from a chat room. |
default void io.agora.ChatRoomChangeListener.onSpecificationChanged | ( | ChatRoom | chatRoom | ) |
Occurs when the chatroom specification changed.
chatRoom | The chatroom. |
void io.agora.ChatRoomChangeListener.onWhiteListAdded | ( | final String | chatRoomId, |
final List< String > | whitelist | ||
) |
Occurs when the chat room member(s) is added to the allowlist.
chatRoomId | The chatroom ID. |
whitelist | The member(s) to be added to the allowlist. |
void io.agora.ChatRoomChangeListener.onWhiteListRemoved | ( | final String | chatRoomId, |
final List< String > | whitelist | ||
) |
Occurs when the chat room member(s) is removed from the allowlist.
chatRoomId | The chatroom ID. |
whitelist | The member(s) is removed from the allowlist. |