hyphenate_SDK4.0 4.10.0
hyphenate java IM SDK
| Public 成员函数 | 所有成员列表
com.hyphenate.chat.EMChatRoom类 参考

继承自 com.hyphenate.chat.EMBase< T > .

enum  EMChatRoomPermissionType
 

Public 成员函数

String getId ()
 
String getName ()
 
String getDescription ()
 
String getOwner ()
 
List< String > getAdminList ()
 
int getMemberCount ()
 
int getMaxUsers ()
 
List< String > getMemberList ()
 
List< String > getBlackList ()
 
List< String > getBlacklist ()
 
Map< String, Long > getMuteList ()
 
List< String > getWhiteList ()
 
List< String > getWhitelist ()
 
boolean isAllMemberMuted ()
 
String getAnnouncement ()
 
EMChatRoomPermissionType getChatRoomPermissionType ()
 

详细描述

聊天室类型。

成员函数说明

◆ getAdminList()

List< String > com.hyphenate.chat.EMChatRoom.getAdminList ( )

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

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

◆ getAnnouncement()

String com.hyphenate.chat.EMChatRoom.getAnnouncement ( )

获取聊天室公告。

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

也可调用其异步方法 EMChatRoomManager#asyncFetchChatRoomAnnouncement(String, EMValueCallBack)

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

◆ getBlackList()

List< String > com.hyphenate.chat.EMChatRoom.getBlackList ( )

返回聊天室黑名单。

获取黑名单可调用 EMChatRoomManager#fetchChatRoomBlackList(String, int, int), 调用该方法需要聊天室所有者或者管理员身份,也可调用其异步方法实现。 EMChatRoomManager#asyncFetchChatRoomBlackList(String, int, int, EMValueCallBack)

返回
返回黑名单列表。如果返回的列表为空,表示未获取到黑名单列表。
弃用:
已废弃,请用 EMChatRoom#getBlacklist() 代替。

◆ getBlacklist()

List< String > com.hyphenate.chat.EMChatRoom.getBlacklist ( )

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

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

◆ getChatRoomPermissionType()

EMChatRoomPermissionType com.hyphenate.chat.EMChatRoom.getChatRoomPermissionType ( )

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

返回
当前用户在聊天室中的角色,见 EMChatRoomPermissionType

◆ getDescription()

String com.hyphenate.chat.EMChatRoom.getDescription ( )

获取聊天室描述。

返回
聊天室描述。

◆ getId()

String com.hyphenate.chat.EMChatRoom.getId ( )

获取聊天室 ID。

返回
聊天室 ID。

◆ getMaxUsers()

int com.hyphenate.chat.EMChatRoom.getMaxUsers ( )

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

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

◆ getMemberCount()

int com.hyphenate.chat.EMChatRoom.getMemberCount ( )

返回在线成员数。

包括聊天室所有者、管理员与普通成员。

返回
在线成员数。

◆ getMemberList()

List< String > com.hyphenate.chat.EMChatRoom.getMemberList ( )

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

◆ getMuteList()

Map< String, Long > com.hyphenate.chat.EMChatRoom.getMuteList ( )

返回禁言列表。

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

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

◆ getName()

String com.hyphenate.chat.EMChatRoom.getName ( )

获取聊天室名称。

返回
聊天室名称。

◆ getOwner()

String com.hyphenate.chat.EMChatRoom.getOwner ( )

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

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

◆ getWhiteList()

List< String > com.hyphenate.chat.EMChatRoom.getWhiteList ( )

返回白名单列表。 获取白名单可调用 EMChatRoomManager#fetchChatRoomWhiteList(String, EMValueCallBack)。 调用这个方法需要聊天室所有者或者管理员身份。

返回
白名单列表。如果返回的列表为空,表示未获取到白名单列表。
弃用:
已废弃,请用 EMChatRoom#getWhitelist() 代替。

◆ getWhitelist()

List< String > com.hyphenate.chat.EMChatRoom.getWhitelist ( )

返回白名单列表。

获取白名单可调用 EMChatRoomManager#fetchChatRoomWhiteList(String, EMValueCallBack)

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

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

◆ isAllMemberMuted()

boolean com.hyphenate.chat.EMChatRoom.isAllMemberMuted ( )

检查是否全员禁言。

此方法存在使用局限性,建议谨慎使用。

使用此方法需注意以下两点:

  • 加入聊天室后,接收到一键禁言/取消禁言的回调后,该状态会被更新,此时使用该方法获取的状态是正确的。
  • 从聊天室退出后再进入聊天室,利用该方法获取的状态不可信。
返回
返回是否全员禁言。
  • true:开启全员禁言。
  • false:关闭全员禁言。

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