io.agora.chat.ChatRoom类 参考

继承自 io.agora.chat.EMBase< T > .

类
enum	ChatRoomPermissionType

Public 成员函数
String	getId ()
String	getName ()
String	getDescription ()
String	getOwner ()
List< String >	getAdminList ()
int	getMemberCount ()
int	getMaxUsers ()
List< String >	getMemberList ()
List< String >	getBlacklist ()
Map< String, Long >	getMuteList ()
List< String >	getWhitelist ()
boolean	isAllMemberMuted ()
String	getAnnouncement ()
ChatRoomPermissionType	getChatRoomPermissionType ()
long	getCreateTimestamp ()
boolean	isInWhitelist ()
long	getMuteExpireTimestamp ()

详细描述

聊天室类型。

成员函数说明

getAdminList()

List< String > io.agora.chat.ChatRoom.getAdminList

(

)

获取聊天室的管理员列表。 获取聊天室详情见 ChatRoomManager#fetchChatRoomFromServer(String)。

返回

管理员 ID 列表。如果返回的值未空，表示未获取到聊天室管理员列表。

getAnnouncement()

String io.agora.chat.ChatRoom.getAnnouncement

(

)

获取聊天室公告。

获取聊天室公告，可调用 ChatRoomManager#fetchChatRoomAnnouncement(String),

也可调用其异步方法 ChatRoomManager#asyncFetchChatRoomAnnouncement(String, ValueCallBack)。

返回

聊天室公告。如果返回的值为空，表示未获取聊天室公告。

getBlacklist()

List< String > io.agora.chat.ChatRoom.getBlacklist

(

)

返回聊天室黑名单。 获取黑名单可调用 ChatRoomManager#fetchChatRoomBlackList(String, int, int)。 调用这个方法需要聊天室所有者或者管理员身份，也可调用其异步方法实现。 ChatRoomManager#asyncFetchChatRoomBlackList(String, int, int, ValueCallBack)

返回

返回黑聊天室名单列表。如果返回的列表为空，表示未获取到黑名单列表。

getChatRoomPermissionType()

ChatRoomPermissionType io.agora.chat.ChatRoom.getChatRoomPermissionType

(

)

获取当前用户在聊天室中的角色。

返回

当前用户在聊天室中的角色，见 ChatRoomPermissionType。

getCreateTimestamp()

long io.agora.chat.ChatRoom.getCreateTimestamp

(

)

获取聊天室创建时间戳。 只有加入聊天室后可获取。

返回

聊天室创建时间戳。

getDescription()

String io.agora.chat.ChatRoom.getDescription

(

)

获取聊天室描述。

返回

聊天室描述。

getId()

String io.agora.chat.ChatRoom.getId

(

)

获取聊天室 ID。

返回

聊天室 ID。

getMaxUsers()

int io.agora.chat.ChatRoom.getMaxUsers

(

)

获取聊天室最大成员数，在创建时确定。 需要获取聊天室详情才能得到正确结果。

返回

聊天室最大成员数。如果未获取聊天室最大成员数，则返回 0。

getMemberCount()

int io.agora.chat.ChatRoom.getMemberCount

(

)

返回在线成员数。

包括聊天室所有者、管理员与普通成员。 加入聊天室即可获取。 当聊天室有成员进出时，此属性会更新。

返回

在线成员数。

getMemberList()

List< String > io.agora.chat.ChatRoom.getMemberList

(

)

返回成员列表。 可通过如下方式获取成员列表：

• 成员数少于 200 时，可通过 ChatRoomManager#fetchChatRoomFromServer(String, boolean), 第二个参数传入 true，最多可获取 200 个成员。
• 通过 ChatRoomManager#fetchChatRoomMembers(String, String, int) 分页获取，也可通过其异步方法 ChatRoomManager#asyncFetchChatRoomMembers(String, String, int, ValueCallBack) 获取.

  返回

  成员 ID 列表。如果返回的列表为空，表示未获取成员列表。

getMuteExpireTimestamp()

long io.agora.chat.ChatRoom.getMuteExpireTimestamp

(

)

获取当前用户被禁言截止时间戳（毫秒）。

加入聊天室后可获取。 当前用户被禁言或者被解除禁言时，此属性会被更新。

返回

当前被禁言截止时间戳（毫秒）。

• 当取值为0，表示当前用户未被禁言。
• 当取值为-1，表示未能获取到用户被禁言时间戳。

getMuteList()

Map< String, Long > io.agora.chat.ChatRoom.getMuteList

(

)

返回禁言列表。

获取禁言列表可调用 ChatRoomManager#fetchChatRoomMuteList(String, int, int)。 调用这个方法需要聊天室所有者或者管理员身份，也可调用其异步方法实现 ChatRoomManager#asyncFetchChatRoomMuteList(String, int, int, ValueCallBack)。

返回

返回禁言列表，Map.entry.key 是禁言的成员 ID，Map.entry.value 是禁言动作存在的时间，单位是毫秒。 如果返回的 map 为空，表示未获取到禁言列表。

getName()

String io.agora.chat.ChatRoom.getName

(

)

获取聊天室名称。

返回

聊天室名称。

getOwner()

String io.agora.chat.ChatRoom.getOwner

(

)

获取聊天室所有者。 获取聊天室详情见 ChatRoomManager#fetchChatRoomFromServer(String)。

返回

聊天室所有者 ID。如果返回的值为空，表示未获取到聊天室所有者。

getWhitelist()

List< String > io.agora.chat.ChatRoom.getWhitelist

(

)

返回白名单列表。

获取白名单可调用 ChatRoomManager#fetchChatRoomWhiteList(String, ValueCallBack)。

调用这个方法需要聊天室所有者或者管理员身份。

返回

白名单列表。如果返回的列表为空，表示未获取到白名单列表。

isAllMemberMuted()

boolean io.agora.chat.ChatRoom.isAllMemberMuted

(

)

检查是否全员禁言,加入聊天室即可获取。

加入聊天室后，收到一键禁言/取消禁言的回调时，该状态会更新。

返回

返回是否全员禁言。

• true：开启全员禁言。
• false：关闭全员禁言。

isInWhitelist()

boolean io.agora.chat.ChatRoom.isInWhitelist

(

)

当前登录用户是否在白名单中。 加入聊天室后可获取。 当前用户被加入或者被移除白名单时，此属性会发生变化。

返回

是否在白名单中。

• true: 在白名单中。
• false: 不在白名单中。

---

该类的文档由以下文件生成:

• io/agora/chat/ChatRoom.java